feat: introduce monorepo to Generator Repo

.github/workflows/update-docs-in-website.yml

@@ -37,10 +37,10 @@ jobs:
         run: |
           rm -r ./pages/docs/tools/generator
           mkdir -p ./pages/docs/tools/generator
-          rm ../generator/docs/README.md
-          rm -r ../generator/docs/jsdoc2md-handlebars
-          printf "%s\ntitle: Generator\nweight: 3\n%s" "---" "---"> ../generator/docs/_section.md
-          mv ../generator/docs/*.md ./pages/docs/tools/generator
+          rm ../generator/apps/generator/docs/README.md
+          rm -r ../generator/apps/generator/docs/jsdoc2md-handlebars
+          printf "%s\ntitle: Generator\nweight: 3\n%s" "---" "---"> ../generator/apps/generator/docs/_section.md
+          mv ../generator/apps/generator/docs/*.md ./pages/docs/tools/generator
       - name: Commit and push
         working-directory: ./website
         run: |
@@ -50,4 +50,4 @@ jobs:
       - name: Create PR
         working-directory: ./website
         run: |
-          gh pr create --title "docs(generator): update latest generator documentation" --body "Updated generator documentation is available and this PR introduces update to generator folder on the website" --head "update-generator-docs-${{ github.sha }}"
+          gh pr create --title "docs(generator): update latest generator documentation" --body "Updated generator documentation is available and this PR introduces update to generator folder on the website" --head "update-generator-docs-${{ github.sha }}"

.gitignore

@@ -1,20 +1,8 @@
 .DS_Store
 node_modules
 npm-debug.log
-output
 .vscode
 ######################
 # Intellij
 ######################
-.idea/
-*.iml
-*.iws
-*.ipr
-*.ids
-*.orig
-out/
-coverage
-test/temp/integrationTestResult
-test/test-project/package-lock.json
-test/test-project/verdaccio/storage/
-test/test-project/storage/
+.turbo

README.md

@@ -26,21 +26,21 @@ There is a large number of templates that are ready to use and are officially su
 <!-- templates list is validated with GitHub Actions do not remove list markers -->
 <!-- TEMPLATES-LIST:START -->
 
-Template Name | Description | Source code
----|---|---
-`@asyncapi/nodejs-template` | Generates Nodejs service that uses Hermes package | [click here](https://github.com/asyncapi/nodejs-template)
-`@asyncapi/nodejs-ws-template` | Generates Nodejs service that supports WebSockets protocol only | [click here](https://github.com/asyncapi/nodejs-ws-template)
-`@asyncapi/java-template` | Generates Java JMS application | [click here](https://github.com/asyncapi/java-template)
-`@asyncapi/java-spring-template` | Generates Java Spring service | [click here](https://github.com/asyncapi/java-spring-template)
-`@asyncapi/java-spring-cloud-stream-template` | Generates Java Spring Cloud Stream service | [click here](https://github.com/asyncapi/java-spring-cloud-stream-template)
-`@asyncapi/python-paho-template` | Generates Python service that uses Paho library | [click here](https://github.com/asyncapi/python-paho-template)
-`@asyncapi/html-template` | Generates HTML documentation site | [click here](https://github.com/asyncapi/html-template)
-`@asyncapi/markdown-template` | Generates documentation in Markdown file | [click here](https://github.com/asyncapi/markdown-template)
-`@asyncapi/ts-nats-template` | Generates TypeScript NATS client | [click here](https://github.com/asyncapi/ts-nats-template/)
-`@asyncapi/go-watermill-template` | Generates Go client using Watermill | [click here](https://github.com/asyncapi/go-watermill-template)
-`@asyncapi/dotnet-nats-template` | Generates .NET C# client using NATS | [click here](https://github.com/asyncapi/dotnet-nats-template)
-`@asyncapi/php-template` | Generates PHP client using RabbitMQ | [click here](https://github.com/asyncapi/php-template)
-`@asyncapi/dotnet-rabbitmq-template` | Generates .NET C# client using RabbitMQ | [click here](https://github.com/asyncapi/dotnet-rabbitmq-template)
+| Template Name                                 | Description                                                     | Source code                                                                 |
+| --------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `@asyncapi/nodejs-template`                   | Generates Nodejs service that uses Hermes package               | [click here](https://github.com/asyncapi/nodejs-template)                   |
+| `@asyncapi/nodejs-ws-template`                | Generates Nodejs service that supports WebSockets protocol only | [click here](https://github.com/asyncapi/nodejs-ws-template)                |
+| `@asyncapi/java-template`                     | Generates Java JMS application                                  | [click here](https://github.com/asyncapi/java-template)                     |
+| `@asyncapi/java-spring-template`              | Generates Java Spring service                                   | [click here](https://github.com/asyncapi/java-spring-template)              |
+| `@asyncapi/java-spring-cloud-stream-template` | Generates Java Spring Cloud Stream service                      | [click here](https://github.com/asyncapi/java-spring-cloud-stream-template) |
+| `@asyncapi/python-paho-template`              | Generates Python service that uses Paho library                 | [click here](https://github.com/asyncapi/python-paho-template)              |
+| `@asyncapi/html-template`                     | Generates HTML documentation site                               | [click here](https://github.com/asyncapi/html-template)                     |
+| `@asyncapi/markdown-template`                 | Generates documentation in Markdown file                        | [click here](https://github.com/asyncapi/markdown-template)                 |
+| `@asyncapi/ts-nats-template`                  | Generates TypeScript NATS client                                | [click here](https://github.com/asyncapi/ts-nats-template/)                 |
+| `@asyncapi/go-watermill-template`             | Generates Go client using Watermill                             | [click here](https://github.com/asyncapi/go-watermill-template)             |
+| `@asyncapi/dotnet-nats-template`              | Generates .NET C# client using NATS                             | [click here](https://github.com/asyncapi/dotnet-nats-template)              |
+| `@asyncapi/php-template`                      | Generates PHP client using RabbitMQ                             | [click here](https://github.com/asyncapi/php-template)                      |
+| `@asyncapi/dotnet-rabbitmq-template`          | Generates .NET C# client using RabbitMQ                         | [click here](https://github.com/asyncapi/dotnet-rabbitmq-template)          |
 
 <!-- TEMPLATES-LIST:END -->
 

apps/generator/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+node_modules
+npm-debug.log
+output
+.vscode
+######################
+# Intellij
+######################
+.idea/
+*.iml
+*.iws
+*.ipr
+*.ids
+*.orig
+out/
+coverage
+test/temp/integrationTestResult
+test/test-project/package-lock.json
+test/test-project/verdaccio/storage/
+test/test-project/storage/
+.turbo

docs/hooks.md → apps/generator/docs/hooks.md

@@ -8,9 +8,9 @@ The following types of hooks are currently supported:
 
 |Hook type|Description| Return type | Arguments 
 |---|---|---|---|
-| `generate:before` | Called after registration of all filters and before the generator starts processing of the template. | void : Nothing is expected to be returned. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md)
-| `generate:after` | Called at the very end of the generation. | void : Nothing is expected to be returned. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md)
-| `setFileTemplateName ` | Called right before saving a new file generated by [file template](./file-templates.md). | string : a new filename for the generator to use for the file template. | [The generator instance](https://github.com/asyncapi/generator/blob/master/docs/api.md) and object in the form of `{ "originalFilename" : string }`
+| `generate:before` | Called after registration of all filters and before the generator starts processing of the template. | void : Nothing is expected to be returned. | [The generator instance]( https://www.asyncapi.com/docs/tools/generator/api)
+| `generate:after` | Called at the very end of the generation. | void : Nothing is expected to be returned. | [The generator instance]( https://www.asyncapi.com/docs/tools/generator/api)
+| `setFileTemplateName ` | Called right before saving a new file generated by [file template](./file-templates.md). | string : a new filename for the generator to use for the file template. | [The generator instance]( https://www.asyncapi.com/docs/tools/generator/api) and object in the form of `{ "originalFilename" : string }`
 
 The generator parses:
 - All the files in the `.hooks` directory inside the template.

apps/generator/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  clearMocks: true,
+  moduleNameMapper: {
+    "^nimma/legacy$":
+      "<rootDir>../../node_modules/nimma/dist/legacy/cjs/index.js",
+    "^nimma/(.*)": "<rootDir>../../node_modules/nimma/dist/cjs/$1",
+  },
+};

apps/generator/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@asyncapi/generator",
+  "version": "1.17.25",
+  "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
+  "main": "./lib/generator.js",
+  "bin": {
+    "asyncapi-generator": "./cli.js",
+    "ag": "./cli.js"
+  },
+  "engines": {
+    "node": ">12.16",
+    "npm": ">6.13.7"
+  },
+  "scripts": {
+    "test": "npm run test:unit && npm run test:integration && npm run test:cli",
+    "test:unit": "jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project",
+    "test:dev": "npm run test:unit -- --watchAll",
+    "test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__'",
+    "test:cli": "node cli.js ./test/docs/dummy.yml @asyncapi/html-template -o test/output --force-write --debug && test -e test/output/index.html",
+    "test:cleanup": "rimraf \"test/temp\"",
+    "docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md",
+    "docker:build": "docker build -t asyncapi/generator:latest .",
+    "lint": "eslint --max-warnings 0 --config .eslintrc .",
+    "lint:tpl:validator": "eslint --fix --config .eslintrc .github/templates-list-validator",
+    "generate:readme:toc": "markdown-toc -i README.md",
+    "generate:assets": "npm run docs && npm run generate:readme:toc",
+    "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION"
+  },
+  "preferGlobal": true,
+  "bugs": {
+    "url": "https://github.com/asyncapi/generator/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/asyncapi/generator.git"
+  },
+  "keywords": [
+    "asyncapi",
+    "documentation",
+    "generator",
+    "markdown",
+    "codegen"
+  ],
+  "author": "Fran Mendez <[email protected]>",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/asyncapi/generator",
+  "dependencies": {
+    "@asyncapi/generator-react-sdk": "^1.0.18",
+    "@asyncapi/parser": "^3.0.14",
+    "@npmcli/arborist": "5.6.3",
+    "@smoya/multi-parser": "^5.0.0",
+    "ajv": "^8.12.0",
+    "chokidar": "^3.4.0",
+    "commander": "^6.1.0",
+    "filenamify": "^4.1.0",
+    "fs.extra": "^1.3.2",
+    "global-dirs": "^3.0.0",
+    "jmespath": "^0.15.0",
+    "js-yaml": "^3.13.1",
+    "levenshtein-edit-distance": "^2.0.5",
+    "loglevel": "^1.6.8",
+    "minimatch": "^3.0.4",
+    "node-fetch": "^2.6.0",
+    "nunjucks": "^3.2.0",
+    "resolve-from": "^5.0.0",
+    "resolve-pkg": "^2.0.0",
+    "semver": "^7.3.2",
+    "simple-git": "^3.3.0",
+    "source-map-support": "^0.5.19",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
+  },
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-plugin-jest": "^23.8.2",
+    "eslint-plugin-sonarjs": "^0.5.0",
+    "jest": "^25.5.0",
+    "jsdoc-to-markdown": "^7.1.1",
+    "markdown-toc": "^1.2.0",
+    "rimraf": "^3.0.2",
+    "unixify": "^1.0.0"
+  }
+}

test/integration.test.js → apps/generator/test/integration.test.js

@@ -24,7 +24,7 @@ describe('Integration testing generateFromFile() to make sure the result of the
 
   it('generated using Nunjucks template', async () => {
     const outputDir = generateFolderName();
-    const generator = new Generator(nunjucksTemplate, outputDir, { 
+    const generator = new Generator(nunjucksTemplate, outputDir, {
       forceWrite: true,
       templateParams: { version: 'v1', mode: 'production' }
     });
@@ -35,7 +35,7 @@ describe('Integration testing generateFromFile() to make sure the result of the
 
   it('generate using React template', async () => {
     const outputDir = generateFolderName();
-    const generator = new Generator(reactTemplate, outputDir, { 
+    const generator = new Generator(reactTemplate, outputDir, {
       forceWrite: true ,
       templateParams: { version: 'v1', mode: 'production' }
     });