chore: add components and helpers packages and show example templ…

…ate (#1315)

Co-authored-by: asyncapi-bot <bot+chan@asyncapi.io>

.eslintignore

@@ -3,4 +3,4 @@ apps/generator/output/*
 .github/templates-list-validator/dist/*
 apps/generator/test/temp/*
 apps/generator/test/test-templates/react-template/__transpiled/*
-
+packages/components/lib/*

.eslintrc

@@ -110,4 +110,5 @@ rules:
   react/react-in-jsx-scope: off
   react/display-name: off
   react/prop-types: off
-  react/jsx-key: off
+  react/jsx-key: off
+  react/no-unescaped-entities: off

.gitignore

@@ -15,3 +15,4 @@ coverage
 .turbo
 
 /.idea
+temp

.sonarcloud.properties

@@ -1,2 +1,2 @@
 #we need to explicitly exclude them as some are commit to the repo
-sonar.exclusions=test/**/*
+sonar.exclusions=**/test/**/*,**/*__transpiled/**/*.js,packages/templates/clients/js/websocket/example.js,

apps/generator/.gitignore

@@ -19,3 +19,4 @@ test/temp/reactTemplate
 test/test-project/package-lock.json
 test/test-project/verdaccio/storage/
 test/test-project/storage/
+__transpiled

apps/generator/package.json

@@ -12,12 +12,11 @@
     "npm": ">=8.19.0"
   },
   "scripts": {
-    "test": "npm run test:unit && npm run test:integration && npm run test:cli",
+    "test": "npm run test:unit && npm run test:integration",
     "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__(?!\\/loglevel\\.js$)'",
     "test:integration:update": "jest --updateSnapshot --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
-    "test:cli": "node cli.js ./test/docs/dummy.yml ./test/test-templates/react-template -o test/output --force-write --debug && test -e test/output/test-file.md",
     "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 .",
@@ -82,7 +81,7 @@
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-sonarjs": "^0.5.0",
-    "fs-extra": "9.1.0",
+    "fs-extra": "11.2.0",
     "jest": "^27.3.1",
     "jsdoc-to-markdown": "^7.1.1",
     "markdown-toc": "^1.2.0",

apps/generator/test/integration.test.js

@@ -10,11 +10,11 @@ const dummySpecPath = path.resolve(__dirname, './docs/dummy.yml');
 const refSpecPath = path.resolve(__dirname, './docs/apiwithref.json');
 const refSpecFolder = path.resolve(__dirname, './docs/');
 const crypto = require('crypto');
-const mainTestResultPath = 'test/temp/integrationTestResult';
-const reactTemplate = 'test/test-templates/react-template';
-const nunjucksTemplate = 'test/test-templates/nunjucks-template';
+const mainTestResultPath = path.resolve(__dirname, './temp/integrationTestResult');
+const reactTemplate = path.resolve(__dirname, './test-templates/react-template');
+const nunjucksTemplate = path.resolve(__dirname, './test-templates/nunjucks-template');
 //temp location where react template is copied for each test that does some mutation on template files
-const copyOfReactTemplate = 'test/temp/reactTemplate';
+const copyOfReactTemplate = path.resolve(__dirname, './temp/reactTemplate');
 
 describe('Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot', () => {
   const generateFolderName = () => {

apps/generator/test/test-project/package.json

@@ -11,7 +11,6 @@
         "test:cleanup": "rimraf \"../temp\""
     },
     "devDependencies": {
-        "fs-extra": "9.1.0",
         "jest": "28.1.3",
         "rimraf": "3.0.2"
     },

apps/generator/test/test-project/test.sh

@@ -71,6 +71,11 @@ Publish test template to local npm-verdaccio
 npm config set -- //verdaccio:4873/:_auth=YWRtaW46bmltZGE=
 npm config set registry http://verdaccio:4873
 
+echo "##########
+Publish @asyncapi/generator-components to local npm-verdaccio
+##########"
+npm publish ../../../../packages/components
+
 echo "##########
 Publishing the correct template as 0.0.1
 ##########"

apps/generator/test/test-project/verdaccio/config.yaml

@@ -10,7 +10,13 @@ packages:
   "react-template":
     access: admin
     publish: admin
+  "@asyncapi/generator-components":
+    access: admin
+    publish: admin
   "!react-template":
     access: admin
     proxy: npmjs
+  "!@asyncapi/generator-components":
+    access: admin
+    proxy: npmjs
 log: { type: stdout, format: pretty, level: error }