@asyncapi/cli 2.1.0 → 2.2.0

package/lib/commands/generate/fromTemplate.js

@@ -272,7 +272,7 @@ class Template extends base_1.default {
             const s = interactive ? (0, prompts_1.spinner)() : { start: () => null, stop: (string) => console.log(string) };
             s.start('Generation in progress. Keep calm and wait a bit');
             try {
-                yield generator.generateFromString(specification.text(), genOption);
+                yield generator.generateFromString(specification.text(), Object.assign(Object.assign({}, genOption), { path: asyncapi }));
             }
             catch (err) {
                 s.stop('Generation failed');

package/lib/commands/validate.d.ts

@@ -2,6 +2,7 @@ import Command from '../core/base';
 export default class Validate extends Command {
     static description: string;
     static flags: {
+        score: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
         'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/commands/validate.js

@@ -7,12 +7,18 @@ const parser_1 = require("../core/parser");
 const SpecificationFile_1 = require("../core/models/SpecificationFile");
 const globals_1 = require("../core/globals");
 const validate_flags_1 = require("../core/flags/validate.flags");
+const scoreCalculator_1 = require("../core/utils/scoreCalculator");
 class Validate extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args, flags } = yield this.parse(Validate); //NOSONAR
             const filePath = args['spec-file'];
             const watchMode = flags.watch;
+            if (flags['score']) {
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+                const { document } = yield (0, parser_1.parse)(this, this.specFile);
+                this.log(`The score of the asyncapi document is ${yield (0, scoreCalculator_1.calculateScore)(document)}`);
+            }
             this.specFile = yield (0, SpecificationFile_1.load)(filePath);
             if (watchMode) {
                 (0, globals_1.specWatcher)({ spec: this.specFile, handler: this, handlerName: 'validate' });

package/lib/core/flags/validate.flags.d.ts

@@ -1,4 +1,5 @@
 export declare const validateFlags: () => {
+    score: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/core/flags/validate.flags.js

@@ -5,6 +5,10 @@ const core_1 = require("@oclif/core");
 const parser_1 = require("../parser");
 const global_flags_1 = require("./global.flags");
 const validateFlags = () => {
-    return Object.assign({ help: core_1.Flags.help({ char: 'h' }), watch: (0, global_flags_1.watchFlag)() }, (0, parser_1.validationFlags)());
+    return Object.assign(Object.assign({ help: core_1.Flags.help({ char: 'h' }), watch: (0, global_flags_1.watchFlag)() }, (0, parser_1.validationFlags)()), { score: core_1.Flags.boolean({
+            description: 'Compute the score of the AsyncAPI document. Scoring is based on whether the document has description, license, server and/or channels.',
+            required: false,
+            default: false
+        }) });
 };
 exports.validateFlags = validateFlags;

package/lib/core/utils/scoreCalculator.d.ts

@@ -0,0 +1,2 @@
+import { AsyncAPIDocumentInterface } from '@asyncapi/parser/cjs/models';
+export declare function calculateScore(document: AsyncAPIDocumentInterface | undefined): Promise<number>;

package/lib/core/utils/scoreCalculator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateScore = void 0;
+const tslib_1 = require("tslib");
+function calculateScore(document) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let scoreEvaluate = 0;
+        if (document === null || document === void 0 ? void 0 : document.info().hasDescription()) {
+            scoreEvaluate += 0.15;
+        }
+        if (document === null || document === void 0 ? void 0 : document.info().hasLicense()) {
+            scoreEvaluate += 0.25;
+        }
+        if (!(document === null || document === void 0 ? void 0 : document.servers().isEmpty())) {
+            scoreEvaluate += 0.25;
+        }
+        if (!(document === null || document === void 0 ? void 0 : document.channels().isEmpty())) {
+            scoreEvaluate += 0.35;
+        }
+        return (scoreEvaluate / 1) * 100;
+    });
+}
+exports.calculateScore = calculateScore;

package/oclif.manifest.json

@@ -394,6 +394,13 @@
             "hint"
           ],
           "type": "option"
+        },
+        "score": {
+          "description": "Compute the score of the AsyncAPI document. Scoring is based on whether the document has description, license, server and/or channels.",
+          "name": "score",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1567,5 +1574,5 @@
       ]
     }
   },
-  "version": "2.1.0"
+  "version": "2.2.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run_bin"