@asyncapi/cli 2.1.1 → 2.3.0

package/lib/commands/optimize.d.ts

@@ -6,6 +6,9 @@ export declare enum Optimizations {
     MOVE_DUPLICATES_TO_COMPONENTS = "move-duplicates-to-components",
     MOVE_ALL_TO_COMPONENTS = "move-all-to-components"
 }
+export declare enum DisableOptimizations {
+    SCHEMA = "schema"
+}
 export declare enum Outputs {
     TERMINAL = "terminal",
     NEW_FILE = "new-file",
@@ -15,11 +18,13 @@ export default class Optimize extends Command {
     static description: string;
     isInteractive: boolean;
     selectedOptimizations?: Optimizations[];
+    disableOptimizations?: DisableOptimizations[];
     outputMethod?: Outputs;
     static examples: string[];
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         optimization: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+        ignore: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
         output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         'no-tty': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/lib/commands/optimize.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Outputs = exports.Optimizations = void 0;
+exports.Outputs = exports.DisableOptimizations = exports.Optimizations = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const optimizer_1 = require("@asyncapi/optimizer");
@@ -20,6 +20,10 @@ var Optimizations;
     Optimizations["MOVE_DUPLICATES_TO_COMPONENTS"] = "move-duplicates-to-components";
     Optimizations["MOVE_ALL_TO_COMPONENTS"] = "move-all-to-components";
 })(Optimizations = exports.Optimizations || (exports.Optimizations = {}));
+var DisableOptimizations;
+(function (DisableOptimizations) {
+    DisableOptimizations["SCHEMA"] = "schema";
+})(DisableOptimizations = exports.DisableOptimizations || (exports.DisableOptimizations = {}));
 var Outputs;
 (function (Outputs) {
     Outputs["TERMINAL"] = "terminal";
@@ -60,6 +64,7 @@ class Optimize extends base_1.default {
             }
             this.isInteractive = !flags['no-tty'];
             this.selectedOptimizations = flags.optimization;
+            this.disableOptimizations = flags.ignore;
             this.outputMethod = flags.output;
             this.metricsMetadata.optimized = false;
             if (!(((_a = report.moveDuplicatesToComponents) === null || _a === void 0 ? void 0 : _a.length) || ((_b = report.removeComponents) === null || _b === void 0 ? void 0 : _b.length) || ((_c = report.reuseComponents) === null || _c === void 0 ? void 0 : _c.length))) {
@@ -76,7 +81,11 @@ class Optimize extends base_1.default {
                         moveAllToComponents: this.selectedOptimizations.includes(Optimizations.MOVE_ALL_TO_COMPONENTS),
                         removeComponents: this.selectedOptimizations.includes(Optimizations.REMOVE_COMPONENTS),
                         reuseComponents: this.selectedOptimizations.includes(Optimizations.REUSE_COMPONENTS)
-                    }, output: optimizer_1.Output.YAML });
+                    },
+                    disableOptimizationFor: {
+                        schema: this.disableOptimizations.includes(DisableOptimizations.SCHEMA)
+                    },
+                    output: optimizer_1.Output.YAML });
                 this.collectMetricsData(report);
                 const specPath = this.specFile.getFilePath();
                 let newPath = '';
@@ -128,7 +137,7 @@ class Optimize extends base_1.default {
         this.log('\n');
     }
     interactiveRun(report) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const canMoveDuplicates = (_a = report.moveDuplicatesToComponents) === null || _a === void 0 ? void 0 : _a.length;
             const canMoveAll = (_b = report.moveAllToComponents) === null || _b === void 0 ? void 0 : _b.length;
@@ -159,6 +168,12 @@ class Optimize extends base_1.default {
                 this.showOptimizations(report.reuseComponents);
                 choices.push({ name: 'reuse components', value: Optimizations.REUSE_COMPONENTS });
             }
+            if ((_j = this.disableOptimizations) === null || _j === void 0 ? void 0 : _j.includes(DisableOptimizations.SCHEMA)) {
+                choices.push({ name: 'Do not ignore schema', value: DisableOptimizations.SCHEMA });
+            }
+            else {
+                choices.push({ name: 'Ignore schema', value: DisableOptimizations.SCHEMA });
+            }
             const optimizationRes = yield inquirer.prompt([{
                     name: 'optimization',
                     message: 'select the type of optimization that you want to apply:',
@@ -166,6 +181,14 @@ class Optimize extends base_1.default {
                     default: 'all',
                     choices
                 }]);
+            if (optimizationRes.optimization.includes('schema')) {
+                if ((_k = this.disableOptimizations) === null || _k === void 0 ? void 0 : _k.includes(DisableOptimizations.SCHEMA)) {
+                    this.disableOptimizations = (_l = this.disableOptimizations) === null || _l === void 0 ? void 0 : _l.filter(opt => opt !== DisableOptimizations.SCHEMA);
+                }
+                else {
+                    this.disableOptimizations = [...(this.disableOptimizations || []), DisableOptimizations.SCHEMA];
+                }
+            }
             this.selectedOptimizations = optimizationRes.optimization;
             const outputRes = yield inquirer.prompt([{
                     name: 'output',
@@ -195,6 +218,7 @@ Optimize.examples = [
     'asyncapi optimize ./asyncapi.yaml --no-tty',
     'asyncapi optimize ./asyncapi.yaml --optimization=remove-components --optimization=reuse-components --optimization=move-all-to-components --no-tty',
     'asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty',
+    'asyncapi optimize ./asyncapi.yaml --ignore=schema'
 ];
 Optimize.flags = (0, optimize_flags_1.optimizeFlags)();
 Optimize.args = {

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/optimize.flags.d.ts

@@ -4,6 +4,9 @@ export declare enum Optimizations {
     MOVE_DUPLICATES_TO_COMPONENTS = "move-duplicates-to-components",
     MOVE_ALL_TO_COMPONENTS = "move-all-to-components"
 }
+export declare enum DisableOptimizations {
+    SCHEMA = "schema"
+}
 export declare enum Outputs {
     TERMINAL = "terminal",
     NEW_FILE = "new-file",
@@ -12,6 +15,7 @@ export declare enum Outputs {
 export declare const optimizeFlags: () => {
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     optimization: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+    ignore: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
     output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'no-tty': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/lib/core/flags/optimize.flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.optimizeFlags = exports.Outputs = exports.Optimizations = void 0;
+exports.optimizeFlags = exports.Outputs = exports.DisableOptimizations = exports.Optimizations = void 0;
 const core_1 = require("@oclif/core");
 var Optimizations;
 (function (Optimizations) {
@@ -9,6 +9,10 @@ var Optimizations;
     Optimizations["MOVE_DUPLICATES_TO_COMPONENTS"] = "move-duplicates-to-components";
     Optimizations["MOVE_ALL_TO_COMPONENTS"] = "move-all-to-components";
 })(Optimizations = exports.Optimizations || (exports.Optimizations = {}));
+var DisableOptimizations;
+(function (DisableOptimizations) {
+    DisableOptimizations["SCHEMA"] = "schema";
+})(DisableOptimizations = exports.DisableOptimizations || (exports.DisableOptimizations = {}));
 var Outputs;
 (function (Outputs) {
     Outputs["TERMINAL"] = "terminal";
@@ -19,6 +23,7 @@ const optimizeFlags = () => {
     return {
         help: core_1.Flags.help({ char: 'h' }),
         optimization: core_1.Flags.string({ char: 'p', default: Object.values(Optimizations), options: Object.values(Optimizations), multiple: true, description: 'select the type of optimizations that you want to apply.' }),
+        ignore: core_1.Flags.string({ char: 'i', default: [], options: Object.values(DisableOptimizations), multiple: true, description: 'list of components to be ignored from the optimization process' }),
         output: core_1.Flags.string({ char: 'o', default: Outputs.TERMINAL, options: Object.values(Outputs), description: 'select where you want the output.' }),
         'no-tty': core_1.Flags.boolean({ description: 'do not use an interactive terminal', default: false }),
     };

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

@@ -268,7 +268,8 @@
         "asyncapi optimize ./asyncapi.yaml",
         "asyncapi optimize ./asyncapi.yaml --no-tty",
         "asyncapi optimize ./asyncapi.yaml --optimization=remove-components --optimization=reuse-components --optimization=move-all-to-components --no-tty",
-        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty"
+        "asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty",
+        "asyncapi optimize ./asyncapi.yaml --ignore=schema"
       ],
       "flags": {
         "help": {
@@ -298,6 +299,18 @@
           ],
           "type": "option"
         },
+        "ignore": {
+          "char": "i",
+          "description": "list of components to be ignored from the optimization process",
+          "name": "ignore",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "schema"
+          ],
+          "type": "option"
+        },
         "output": {
           "char": "o",
           "description": "select where you want the output.",
@@ -394,6 +407,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 +1587,5 @@
       ]
     }
   },
-  "version": "2.1.1"
+  "version": "2.3.0"
 }

package/package.json

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