@asyncapi/generator 2.0.3 → 2.1.1

package/.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @asyncapi/generator
+
+## 2.1.1
+
+### Patch Changes
+
+- 36ee8a8: Fix docker image publishing. Removed package name from version tag for Docker tagging.
+
+## 2.1.0
+
+### Minor Changes
+
+- 99a14a8: - New release pipeline supporting monorepo,
+  - Package `@asyncapi/generator-filters` is now part of `generator` repo and won't be released separately. New name of the library is `nunjuckis-filters`,
+  - By default `@asyncapi/generator-filters` package, known as package with a lot of different nunjucks filters, is registered and added to generator and you no longer have to configure it in your `package.json`. Package `@asyncapi/generator-filters` will no longer be published to NPM separately and is deprecated.

package/docs/configuration-file.md

@@ -60,8 +60,8 @@ The `generator` property from `package.json` file must contain a JSON object tha
     "lib/lib/config.js"
   ],
   "generator": "<2.0.0",
-  "filters": [
-    "@asyncapi/generator-filters"
+  "filters":[
+    "my-package-with-filters"
   ],
   "hooks": {
     "@asyncapi/generator-hooks": "hookFunctionName"

package/docs/nunjucks-render-engine.md

@@ -73,6 +73,7 @@ async function asyncCamelCase(str, callback) {
 }
 ```
 
-In case you have more than one template and want to reuse filters, you can put them in a single library. You can configure such a library in the template configuration under `filters` property. You can also use the official AsyncAPI [filters library](https://github.com/asyncapi/generator-filters). To learn how to add such filters to configuration [read more about the configuration file](#configuration-file).
+In case you have more than one template and want to reuse filters, you can put them in a single library. You can configure such a library in the template configuration under `filters` property. To learn how to add such filters to configuration [read more about the configuration file](#configuration-file).
 
 
+You can also use the official AsyncAPI [nunjucks-filters](/apps/nunjucks-filters) that are by default included in the generator library.

package/jest.config.js

@@ -0,0 +1,9 @@
+const path = require('path');
+module.exports = {
+  clearMocks: true,
+  moduleNameMapper: {
+    '^nimma/legacy$': '<rootDir>../../node_modules/nimma/dist/legacy/cjs/index.js',
+    '^nimma/(.*)': '<rootDir>../../node_modules/nimma/dist/cjs/$1',
+    '^nunjucks-filters$': path.resolve(__dirname, '../nunjucks-filters'),
+  },
+};

package/lib/__mocks__/filtersRegistry.js

@@ -0,0 +1,3 @@
+const filtersRegistry = jest.genMockFromModule('../filtersRegistry');
+
+module.exports = filtersRegistry;

package/lib/__mocks__/hooksRegistry.js

@@ -0,0 +1,3 @@
+const hooksRegistry = jest.genMockFromModule('../hooksRegistry');
+
+module.exports = hooksRegistry;

package/lib/__mocks__/templateConfigValidator.js

@@ -0,0 +1,3 @@
+const templateConfigValidator = jest.genMockFromModule('../templateConfigValidator');
+
+module.exports = templateConfigValidator;

package/lib/__mocks__/utils.js

@@ -0,0 +1,25 @@
+const utils = jest.genMockFromModule('../utils');
+
+utils.__files = {};
+utils.readFile = jest.fn(async (filePath) => {
+  return utils.__files[filePath];
+});
+
+utils.__contentOfFetchedFile = '';
+utils.fetchSpec = jest.fn(async (fileUrl) => {
+  return utils.__contentOfFetchedFile;
+});
+
+utils.__isFileSystemPathValue = false;
+utils.isFileSystemPath = jest.fn(() => utils.__isFileSystemPathValue);
+
+utils.__isLocalTemplateValue = false;
+utils.isLocalTemplate = jest.fn(async () => utils.__isLocalTemplateValue);
+
+utils.__generatorVersion = '';
+utils.getGeneratorVersion = jest.fn(() => utils.__generatorVersion);
+
+utils.__getTemplateDetails = {};
+utils.getTemplateDetails = jest.fn(() => utils.__getTemplateDetails);
+
+module.exports = utils;

package/lib/filtersRegistry.js

@@ -2,6 +2,7 @@ const path = require('path');
 const fs = require('fs');
 const xfs = require('fs.extra');
 const { isAsyncFunction } = require('./utils');
+const nunjucksFilters = require('nunjucks-filters');
 
 /**
  * Registers all template filters.
@@ -13,6 +14,9 @@ const { isAsyncFunction } = require('./utils');
 module.exports.registerFilters = async (nunjucks, templateConfig, templateDir, filtersDir) => {
   await registerLocalFilters(nunjucks, templateDir, filtersDir);
   registerConfigFilters(nunjucks, templateDir, templateConfig);
+
+  // Register Nunjucks filters from the 'nunjucks-filters' module without needing to list them explicitly in package.json
+  addFilters(nunjucks, nunjucksFilters);
 };
 
 /**
@@ -40,7 +44,7 @@ function registerLocalFilters(nunjucks, templateDir, filtersDir) {
         const mod = require(filePath);
 
         addFilters(nunjucks, mod);
-        
+
         next();
       } catch (e) {
         reject(e);
@@ -58,14 +62,14 @@ function registerLocalFilters(nunjucks, templateDir, filtersDir) {
 }
 
 /**
-* Registers the additionally configured filters.
-* @private
-* @param {Object} nunjucks Nunjucks environment.
-* @param {String} templateDir Directory where template is located.
-* @param {Object} templateConfig Template configuration.
-*/
+ * Registers the additionally configured filters.
+ * @private
+ * @param {Object} nunjucks Nunjucks environment.
+ * @param {String} templateDir Directory where template is located.
+ * @param {Object} templateConfig Template configuration.
+ */
 async function registerConfigFilters(nunjucks, templateDir, templateConfig) {
-  const confFilters = templateConfig.filters; 
+  const confFilters = templateConfig.filters;
   const DEFAULT_MODULES_DIR = 'node_modules';
   if (!Array.isArray(confFilters)) return;
 
@@ -87,7 +91,7 @@ async function registerConfigFilters(nunjucks, templateDir, templateConfig) {
           filterName = path.resolve(templateDir, '../..', filtersModule);
           mod = require(filterName);
         } catch (error) {
-          //in rare cases, especially in isolated tests, it may happen that installation 
+          //in rare cases, especially in isolated tests, it may happen that installation
           //ends but is not yet fully completed, so initial require of the same path do not work
           //but in next attempt it works
           //we need to keep this workaround until we find a solution
@@ -117,5 +121,5 @@ function addFilters(nunjucks, filters) {
     } else {
       nunjucks.addFilter(key, value);
     }
-  });      
+  });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -21,8 +21,8 @@
     "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",
+    "lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "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"
@@ -49,10 +49,10 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
-    "@asyncapi/generator-react-sdk": "^1.0.19",
-    "@asyncapi/parser": "^3.0.16",
     "@npmcli/arborist": "5.6.3",
     "@npmcli/config": "^8.0.2",
+    "@asyncapi/generator-react-sdk": "^1.0.18",
+    "@asyncapi/parser": "^3.0.14",
     "@smoya/multi-parser": "^5.0.0",
     "ajv": "^8.12.0",
     "chokidar": "^3.4.0",
@@ -74,15 +74,15 @@
     "simple-git": "^3.3.0",
     "source-map-support": "^0.5.19",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.3",
+    "nunjucks-filters": "file:../nunjucks-filters"
   },
   "devDependencies": {
-    "conventional-changelog-conventionalcommits": "^5.0.0",
     "eslint": "^6.8.0",
     "eslint-plugin-jest": "^23.8.2",
-    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-sonarjs": "^0.5.0",
-    "jest": "^25.5.0",
+    "eslint-plugin-react": "^7.34.1",
+    "jest": "^27.3.1",
     "jsdoc-to-markdown": "^7.1.1",
     "markdown-toc": "^1.2.0",
     "rimraf": "^3.0.2",

package/test/__mocks__/@npmcli/arborist.js

@@ -0,0 +1,11 @@
+const arb = jest.genMockFromModule('@npmcli/arborist');
+
+arb.prototype[Symbol.for('resolvedAdd')] = [{name: 'test'}];
+
+arb.prototype.reify = jest.fn(async (opt) => {
+  const childrenMap = new Map();
+  childrenMap.set('test', {path: './test'});
+  return { children: childrenMap };
+});
+
+module.exports = arb;

package/test/__mocks__/@npmcli/config.js

@@ -0,0 +1,3 @@
+const npmConfig = jest.genMockFromModule('@npmcli/config');
+
+module.exports = npmConfig;

package/test/__mocks__/fs.extra.js

@@ -0,0 +1,3 @@
+const xfs = jest.genMockFromModule('fs.extra');
+
+module.exports = xfs;

package/test/__mocks__/loglevel.js

@@ -0,0 +1,3 @@
+const log = jest.genMockFromModule('loglevel');
+
+module.exports = log;

package/test/__mocks__/resolve-from.js

@@ -0,0 +1,8 @@
+let resolveFrom = jest.genMockFromModule('resolve-from');
+
+resolveFrom.__resolveFromValue = '';
+resolveFrom = jest.fn((path) => {
+  return resolveFrom.__resolveFromValue;
+});
+
+module.exports = resolveFrom;

package/test/__mocks__/resolve-pkg.js

@@ -0,0 +1,8 @@
+let resolvePkg = jest.genMockFromModule('resolve-pkg');
+
+resolvePkg.__resolvePkgValue = '';
+resolvePkg = jest.fn((path) => {
+  return resolvePkg.__resolvePkgValue;
+});
+
+module.exports = resolvePkg;

package/test/__snapshots__/integration.test.js.snap

@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot generate json based api with referenced JSON Schema 1`] = `
+"This is a markdown file for my application.
+App name is: **This is Async API with a schema reference**
+Version v1 running on production mode 
+"
+`;
+
+exports[`Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot generate using React template 1`] = `
+"This is a markdown file for my application.
+App name is: **Dummy example with all spec features included**
+Version v1 running on production mode 
+"
+`;
+
+exports[`Integration testing generateFromFile() to make sure the result of the generation is not changend comparing to snapshot generated using Nunjucks template 1`] = `
+"This is a markdown file for my application.
+App name is: **Dummy example with all spec features included**
+Version v1 running on production mode
+
+HTML description: **<p>This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.</p>
+<p>It's goal is to support development of documentation and code generation with the <a href="https://github.com/asyncapi/generator/">AsyncAPI Generator</a> and <a href="https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate">Template projects</a></p>
+**"
+`;

package/test/docs/apiwithref.json

@@ -0,0 +1,41 @@
+{
+  "asyncapi": "2.0.0",
+  "info": {
+    "title": "This is Async API with a schema reference",
+    "version": "0.0.1"
+  },
+  "channels": {
+    "VirtualTopic.crmservice": {
+      "publish": {
+        "message": {
+          "oneOf": [
+            {
+              "$ref": "#/components/messages/crm:Customer.Created"
+            },
+            {
+              "$ref": "#/components/messages/crm:Customer.Updated"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "components": {
+    "messages": {
+      "crm:Customer.Created": {
+        "summary": "A customer was created",
+        "schemaFormat": "application/schema+json;version=draft-07",
+        "payload": {
+          "$ref": "https://schema.example.com/crm/shared.json"
+        }
+      },
+      "crm:Customer.Updated": {
+        "summary": "A customer was created",
+        "schemaFormat": "application/schema+json;version=draft-07",
+        "payload": {
+          "$ref": "https://schema.example.com/crm/shared.json"
+        }
+      }
+    }
+  }
+}