@asyncapi/cli 3.2.0 → 3.3.0

package/lib/core/parser.d.ts

@@ -1,35 +0,0 @@
-import { convertToOldAPI } from '@asyncapi/parser/cjs';
-import { OutputFormat } from '@stoplight/spectral-cli/dist/services/config';
-import type { Diagnostic } from '@asyncapi/parser/cjs';
-import type Command from './base';
-import type { Specification } from './models/SpecificationFile';
-export type SeverityKind = 'error' | 'warn' | 'info' | 'hint';
-export { convertToOldAPI };
-export interface ValidationFlagsOptions {
-    logDiagnostics?: boolean;
-}
-export declare enum ValidationStatus {
-    INVALID = "invalid",
-    VALID = "valid"
-}
-export declare function validationFlags({ logDiagnostics }?: ValidationFlagsOptions): {
-    'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-    'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-};
-export interface ValidateOptions {
-    'log-diagnostics'?: boolean;
-    'diagnostics-format'?: `${OutputFormat}`;
-    'fail-severity'?: SeverityKind;
-    'output'?: string;
-    suppressWarnings?: string[];
-    suppressAllWarnings?: boolean;
-}
-export declare function validate(command: Command, specFile: Specification, options?: ValidateOptions): Promise<"invalid" | "valid">;
-export declare function parse(command: Command, specFile: Specification, options?: ValidateOptions): Promise<{
-    document: import("@asyncapi/parser/cjs").AsyncAPIDocumentInterface | undefined;
-    diagnostics: import("@stoplight/spectral-core").ISpectralDiagnostic[];
-    status: "invalid" | "valid";
-}>;
-export declare function formatOutput(diagnostics: Diagnostic[], format: `${OutputFormat}`, failSeverity: SeverityKind): string;

package/lib/core/parser.js

@@ -1,230 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationStatus = exports.convertToOldAPI = void 0;
-exports.validationFlags = validationFlags;
-exports.validate = validate;
-exports.parse = parse;
-exports.formatOutput = formatOutput;
-const tslib_1 = require("tslib");
-const avro_schema_parser_1 = require("@asyncapi/avro-schema-parser");
-const openapi_schema_parser_1 = require("@asyncapi/openapi-schema-parser");
-const cjs_1 = require("@asyncapi/parser/cjs");
-Object.defineProperty(exports, "convertToOldAPI", { enumerable: true, get: function () { return cjs_1.convertToOldAPI; } });
-const raml_dt_schema_parser_1 = require("@asyncapi/raml-dt-schema-parser");
-const core_1 = require("@oclif/core");
-const protobuf_schema_parser_1 = require("@asyncapi/protobuf-schema-parser");
-const spectral_core_1 = require("@stoplight/spectral-core");
-const config_1 = require("@stoplight/spectral-cli/dist/services/config");
-const spectral_formatters_1 = require("@stoplight/spectral-formatters");
-const chalk_1 = require("chalk");
-const fs_1 = require("fs");
-const path_1 = tslib_1.__importDefault(require("path"));
-const { writeFile } = fs_1.promises;
-const formatExtensions = {
-    stylish: '.txt',
-    json: '.json',
-    junit: '.xml',
-    html: '.html',
-    text: '.txt',
-    teamcity: '.txt',
-    pretty: '.txt',
-};
-const validFormats = ['stylish', 'json', 'junit', 'html', 'text', 'teamcity', 'pretty'];
-const parser = new cjs_1.Parser({
-    __unstable: {
-        resolver: {
-            cache: false,
-        }
-    },
-});
-parser.registerSchemaParser((0, avro_schema_parser_1.AvroSchemaParser)());
-parser.registerSchemaParser((0, openapi_schema_parser_1.OpenAPISchemaParser)());
-parser.registerSchemaParser((0, raml_dt_schema_parser_1.RamlDTSchemaParser)());
-parser.registerSchemaParser((0, protobuf_schema_parser_1.ProtoBuffSchemaParser)());
-var ValidationStatus;
-(function (ValidationStatus) {
-    ValidationStatus["INVALID"] = "invalid";
-    ValidationStatus["VALID"] = "valid";
-})(ValidationStatus || (exports.ValidationStatus = ValidationStatus = {}));
-function validationFlags({ logDiagnostics = true } = {}) {
-    return {
-        'log-diagnostics': core_1.Flags.boolean({
-            description: 'log validation diagnostics or not',
-            default: logDiagnostics,
-            allowNo: true,
-        }),
-        'diagnostics-format': core_1.Flags.option({
-            description: 'format to use for validation diagnostics',
-            options: Object.values(config_1.OutputFormat),
-            default: config_1.OutputFormat.STYLISH,
-        })(),
-        'fail-severity': core_1.Flags.option({
-            description: 'diagnostics of this level or above will trigger a failure exit code',
-            options: ['error', 'warn', 'info', 'hint'],
-            default: 'error',
-        })(),
-        output: core_1.Flags.string({
-            description: 'The output file name. Omitting this flag the result will be printed in the console.',
-            char: 'o'
-        })
-    };
-}
-function validate(command_1, specFile_1) {
-    return tslib_1.__awaiter(this, arguments, void 0, function* (command, specFile, options = {}) {
-        var _a, _b;
-        const suppressAllWarnings = (_a = options.suppressAllWarnings) !== null && _a !== void 0 ? _a : false;
-        const suppressedWarnings = (_b = options.suppressWarnings) !== null && _b !== void 0 ? _b : [];
-        let activeParser;
-        // Helper to build a parser with given rules turned off
-        const buildCustomParser = (rulesToSuppress) => new cjs_1.Parser({
-            ruleset: {
-                extends: [],
-                rules: Object.fromEntries(rulesToSuppress.map(rule => [rule, 'off'])),
-            },
-            __unstable: {
-                resolver: {
-                    cache: false,
-                },
-            },
-        });
-        if (suppressAllWarnings) {
-            // Run the default parser to discover all rule codes
-            const diagnostics = yield parser.validate(specFile.text(), {
-                source: specFile.getSource(),
-            });
-            const allRuleNames = Array.from(new Set(diagnostics.map(d => d.code).filter((c) => typeof c === 'string')));
-            activeParser = buildCustomParser(allRuleNames);
-        }
-        else if (suppressedWarnings.length === 0) {
-            activeParser = parser;
-        }
-        else {
-            try {
-                activeParser = buildCustomParser(suppressedWarnings);
-            }
-            catch (e) {
-                const msg = e.message || '';
-                const matches = [...msg.matchAll(/Cannot extend non-existing rule: "([^"]+)"/g)];
-                const invalidRules = matches.map(m => m[1]);
-                if (invalidRules.length > 0) {
-                    for (const rule of invalidRules) {
-                        command.log(`Warning: '${rule}' is not a known rule and will be ignored.`);
-                    }
-                    const validRules = suppressedWarnings.filter(rule => !invalidRules.includes(rule));
-                    activeParser = buildCustomParser(validRules);
-                }
-                else {
-                    throw e;
-                }
-            }
-        }
-        // Register schema parsers
-        activeParser.registerSchemaParser((0, avro_schema_parser_1.AvroSchemaParser)());
-        activeParser.registerSchemaParser((0, openapi_schema_parser_1.OpenAPISchemaParser)());
-        activeParser.registerSchemaParser((0, raml_dt_schema_parser_1.RamlDTSchemaParser)());
-        activeParser.registerSchemaParser((0, protobuf_schema_parser_1.ProtoBuffSchemaParser)());
-        const diagnostics = yield activeParser.validate(specFile.text(), {
-            source: specFile.getSource(),
-        });
-        return logDiagnostics(diagnostics, command, specFile, options);
-    });
-}
-function parse(command_1, specFile_1) {
-    return tslib_1.__awaiter(this, arguments, void 0, function* (command, specFile, options = {}) {
-        const { document, diagnostics } = yield parser.parse(specFile.text(), { source: specFile.getSource() });
-        const status = logDiagnostics(diagnostics, command, specFile, options);
-        return { document, diagnostics, status };
-    });
-}
-function logDiagnostics(diagnostics, command, specFile, options = {}) {
-    var _a, _b;
-    const logDiagnostics = options['log-diagnostics'];
-    const failSeverity = (_a = options['fail-severity']) !== null && _a !== void 0 ? _a : 'error';
-    const diagnosticsFormat = (_b = options['diagnostics-format']) !== null && _b !== void 0 ? _b : 'stylish';
-    const sourceString = specFile.toSourceString();
-    const hasIssues = diagnostics.length > 0;
-    const isFailSeverity = hasIssues && hasFailSeverity(diagnostics, failSeverity);
-    if (logDiagnostics) {
-        logGovernanceMessage(command, sourceString, hasIssues, isFailSeverity);
-        outputDiagnostics(command, diagnostics, diagnosticsFormat, failSeverity, options);
-    }
-    return isFailSeverity ? ValidationStatus.INVALID : ValidationStatus.VALID;
-}
-function logGovernanceMessage(command, sourceString, hasIssues, isFailSeverity) {
-    if (!hasIssues) {
-        command.log(`\n${sourceString} is valid! ${sourceString} and referenced documents don't have governance issues.`);
-    }
-    else if (isFailSeverity) {
-        command.logToStderr(`\n${sourceString} and/or referenced documents have governance issues.`);
-    }
-    else {
-        command.log(`\n${sourceString} is valid but has (itself and/or referenced documents) governance issues.`);
-    }
-}
-function outputDiagnostics(command, diagnostics, diagnosticsFormat, failSeverity, options) {
-    const diagnosticsOutput = formatOutput(diagnostics, diagnosticsFormat, failSeverity);
-    if (options.output) {
-        writeValidationDiagnostic(options.output, command, diagnosticsFormat, diagnosticsOutput);
-    }
-    else {
-        command.log(diagnosticsOutput);
-    }
-}
-function formatOutput(diagnostics, format, failSeverity) {
-    const diagnosticSeverity = (0, spectral_core_1.getDiagnosticSeverity)(failSeverity);
-    const options = { failSeverity: diagnosticSeverity !== -1 ? diagnosticSeverity : cjs_1.DiagnosticSeverity.Error };
-    switch (format) {
-        case 'stylish': return formatStylish(diagnostics, options);
-        case 'json': return (0, spectral_formatters_1.json)(diagnostics, options);
-        case 'junit': return (0, spectral_formatters_1.junit)(diagnostics, options);
-        case 'html': return (0, spectral_formatters_1.html)(diagnostics, options);
-        case 'text': return (0, spectral_formatters_1.text)(diagnostics, options);
-        case 'teamcity': return (0, spectral_formatters_1.teamcity)(diagnostics, options);
-        case 'pretty': return (0, spectral_formatters_1.pretty)(diagnostics, options);
-        default: return (0, spectral_formatters_1.stylish)(diagnostics, options);
-    }
-}
-function formatStylish(diagnostics, options) {
-    const groupedDiagnostics = diagnostics.reduce((acc, diagnostic) => {
-        const severity = diagnostic.severity;
-        if (!acc[severity]) {
-            acc[severity] = [];
-        }
-        acc[severity].push(diagnostic);
-        return acc;
-    }, {});
-    return Object.entries(groupedDiagnostics).map(([severity, diagnostics]) => {
-        return `${getSeverityTitle(Number(severity))} ${(0, spectral_formatters_1.stylish)(diagnostics, options)}`;
-    }).join('\n');
-}
-function getSeverityTitle(severity) {
-    switch (severity) {
-        case cjs_1.DiagnosticSeverity.Error: return (0, chalk_1.red)('Errors');
-        case cjs_1.DiagnosticSeverity.Warning: return (0, chalk_1.yellow)('Warnings');
-        case cjs_1.DiagnosticSeverity.Information: return (0, chalk_1.cyan)('Information');
-        case cjs_1.DiagnosticSeverity.Hint: return (0, chalk_1.green)('Hints');
-    }
-}
-function hasFailSeverity(diagnostics, failSeverity) {
-    const diagnosticSeverity = (0, spectral_core_1.getDiagnosticSeverity)(failSeverity);
-    return diagnostics.some(diagnostic => diagnostic.severity <= diagnosticSeverity);
-}
-function writeValidationDiagnostic(outputPath, command, format, formatOutput) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        if (!validFormats.includes(format)) {
-            command.logToStderr(`Invalid diagnostics format: "${format}"`);
-            return;
-        }
-        const expectedExtension = formatExtensions[format];
-        const actualExtension = path_1.default.extname(outputPath);
-        // Validate file extension against diagnostics format
-        if (expectedExtension && (actualExtension !== expectedExtension)) {
-            command.logToStderr(`Invalid file extension for format "${format}". Expected extension: "${expectedExtension}"`);
-        }
-        else {
-            yield writeFile(path_1.default.resolve(process.cwd(), outputPath), formatOutput, {
-                encoding: 'utf-8',
-            }).catch(err => console.log(err));
-        }
-    });
-}