@eventcatalog/linter 1.0.0 → 1.0.1

package/dist/types/index.d.ts

@@ -1,82 +0,0 @@
-export interface Badge {
-    content: string;
-    backgroundColor: string;
-    textColor: string;
-    icon?: string;
-    link?: string;
-}
-export interface Specification {
-    type: 'asyncapi' | 'openapi';
-    path: string;
-    name?: string;
-}
-export interface Repository {
-    language: string;
-    url: string;
-}
-export interface DraftObject {
-    title: string;
-    message: string;
-}
-export interface DeprecatedObject {
-    date: string;
-    message?: string;
-}
-export interface ResourceReference {
-    id: string;
-    version?: string;
-}
-export interface Parameter {
-    enum?: string[];
-    description?: string;
-    examples?: string[];
-    default?: string;
-}
-export interface FlowStep {
-    id: string;
-    title: string;
-    summary?: string;
-    actor?: {
-        name: string;
-    };
-    message?: {
-        id: string;
-        version: string;
-    };
-    service?: {
-        id: string;
-        version: string;
-    };
-    externalSystem?: {
-        name: string;
-        summary?: string;
-        url?: string;
-    };
-    next_step?: string;
-    next_steps?: string[];
-}
-export interface EntityProperty {
-    name: string;
-    type: string;
-    required?: boolean;
-    description?: string;
-    references?: string;
-    referencesIdentifier?: string;
-    relationType?: 'one-to-one' | 'one-to-many';
-}
-export interface ValidationError {
-    type: 'schema' | 'reference';
-    resource: string;
-    field?: string;
-    message: string;
-    file: string;
-    line?: number;
-    severity?: 'error' | 'warning';
-    rule?: string;
-}
-export interface LinterOptions {
-    rootDir: string;
-    failOnWarning?: boolean;
-    verbose?: boolean;
-}
-//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,cAAc,CAAC,EAAE;QACf,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CAC7C;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,GAAG,WAAW,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/types/index.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/validators/best-practices-validator.d.ts

@@ -1,4 +0,0 @@
-import { ParsedFile } from '../parser';
-import { ValidationError } from '../types';
-export declare const validateBestPractices: (parsedFiles: ParsedFile[]) => ValidationError[];
-//# sourceMappingURL=best-practices-validator.d.ts.map

package/dist/validators/best-practices-validator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"best-practices-validator.d.ts","sourceRoot":"","sources":["../../src/validators/best-practices-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,eAAO,MAAM,qBAAqB,GAAI,aAAa,UAAU,EAAE,KAAG,eAAe,EAmEhF,CAAC"}

package/dist/validators/best-practices-validator.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBestPractices = void 0;
-const validateBestPractices = (parsedFiles) => {
-    const errors = [];
-    for (const parsedFile of parsedFiles) {
-        const { file, frontmatter, content } = parsedFile;
-        // Check for required summary
-        if (!frontmatter.summary || (typeof frontmatter.summary === 'string' && frontmatter.summary.trim() === '')) {
-            errors.push({
-                type: 'schema',
-                resource: `${file.resourceType}/${file.resourceId}`,
-                field: 'summary',
-                message: 'Summary is required for better documentation',
-                file: file.relativePath,
-                severity: 'error',
-                rule: 'best-practices/summary-required',
-            });
-        }
-        // Check for required owners (skip users and teams - they are owners, not owned)
-        if (file.resourceType !== 'user' &&
-            file.resourceType !== 'team' &&
-            (!frontmatter.owners || !Array.isArray(frontmatter.owners) || frontmatter.owners.length === 0)) {
-            errors.push({
-                type: 'schema',
-                resource: `${file.resourceType}/${file.resourceId}`,
-                field: 'owners',
-                message: 'At least one owner is required',
-                file: file.relativePath,
-                severity: 'error',
-                rule: 'best-practices/owner-required',
-            });
-        }
-        // Check for required description (markdown body content)
-        if (!content || content.trim() === '') {
-            errors.push({
-                type: 'schema',
-                resource: `${file.resourceType}/${file.resourceId}`,
-                field: 'description',
-                message: 'Resource should have a markdown description (body content) beyond just frontmatter',
-                file: file.relativePath,
-                severity: 'warning',
-                rule: 'best-practices/description-required',
-            });
-        }
-        // Check for required schemaPath on messages (events, commands, queries)
-        if ((file.resourceType === 'event' || file.resourceType === 'command' || file.resourceType === 'query') &&
-            !frontmatter.schemaPath) {
-            errors.push({
-                type: 'schema',
-                resource: `${file.resourceType}/${file.resourceId}`,
-                field: 'schemaPath',
-                message: `${file.resourceType} should have a schemaPath defined for consumers to understand the contract`,
-                file: file.relativePath,
-                severity: 'warning',
-                rule: 'best-practices/schema-required',
-            });
-        }
-    }
-    return errors;
-};
-exports.validateBestPractices = validateBestPractices;
-//# sourceMappingURL=best-practices-validator.js.map

package/dist/validators/best-practices-validator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"best-practices-validator.js","sourceRoot":"","sources":["../../src/validators/best-practices-validator.ts"],"names":[],"mappings":";;;AAGO,MAAM,qBAAqB,GAAG,CAAC,WAAyB,EAAqB,EAAE;IACpF,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC;QAElD,6BAA6B;QAC7B,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,CAAC,OAAO,WAAW,CAAC,OAAO,KAAK,QAAQ,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YAC3G,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE;gBACnD,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,8CAA8C;gBACvD,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,iCAAiC;aACxC,CAAC,CAAC;QACL,CAAC;QAED,gFAAgF;QAChF,IACE,IAAI,CAAC,YAAY,KAAK,MAAM;YAC5B,IAAI,CAAC,YAAY,KAAK,MAAM;YAC5B,CAAC,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,EAC9F,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE;gBACnD,KAAK,EAAE,QAAQ;gBACf,OAAO,EAAE,gCAAgC;gBACzC,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,+BAA+B;aACtC,CAAC,CAAC;QACL,CAAC;QAED,yDAAyD;QACzD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE;gBACnD,KAAK,EAAE,aAAa;gBACpB,OAAO,EAAE,oFAAoF;gBAC7F,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,qCAAqC;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,wEAAwE;QACxE,IACE,CAAC,IAAI,CAAC,YAAY,KAAK,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,OAAO,CAAC;YACnG,CAAC,WAAW,CAAC,UAAU,EACvB,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE;gBACnD,KAAK,EAAE,YAAY;gBACnB,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,4EAA4E;gBACzG,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,gCAAgC;aACvC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAnEW,QAAA,qBAAqB,yBAmEhC"}

package/dist/validators/index.d.ts

@@ -1,8 +0,0 @@
-export * from './schema-validator';
-export * from './reference-validator';
-export * from './best-practices-validator';
-import { ParsedFile } from '../parser';
-import { ValidationError } from '../types';
-import { CatalogDependencies } from '../config';
-export declare const validateCatalog: (parsedFiles: ParsedFile[], dependencies?: CatalogDependencies) => ValidationError[];
-//# sourceMappingURL=index.d.ts.map

package/dist/validators/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAUhD,eAAO,MAAM,eAAe,GAAI,aAAa,UAAU,EAAE,EAAE,eAAe,mBAAmB,KAAG,eAAe,EAgB9G,CAAC"}

package/dist/validators/index.js

@@ -1,41 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCatalog = void 0;
-__exportStar(require("./schema-validator"), exports);
-__exportStar(require("./reference-validator"), exports);
-__exportStar(require("./best-practices-validator"), exports);
-const schema_validator_1 = require("./schema-validator");
-const reference_validator_1 = require("./reference-validator");
-const best_practices_validator_1 = require("./best-practices-validator");
-const validateCatalog = (parsedFiles, dependencies) => {
-    const schemaErrors = (0, schema_validator_1.validateAllSchemas)(parsedFiles);
-    const referenceErrors = (0, reference_validator_1.validateReferences)(parsedFiles, dependencies);
-    const orphanErrors = (0, reference_validator_1.validateOrphanMessages)(parsedFiles, dependencies);
-    const deprecatedRefErrors = (0, reference_validator_1.validateDeprecatedReferences)(parsedFiles);
-    const duplicateErrors = (0, reference_validator_1.validateDuplicateResourceIds)(parsedFiles);
-    const bestPracticeErrors = (0, best_practices_validator_1.validateBestPractices)(parsedFiles);
-    return [
-        ...schemaErrors,
-        ...referenceErrors,
-        ...orphanErrors,
-        ...deprecatedRefErrors,
-        ...duplicateErrors,
-        ...bestPracticeErrors,
-    ];
-};
-exports.validateCatalog = validateCatalog;
-//# sourceMappingURL=index.js.map

package/dist/validators/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,wDAAsC;AACtC,6DAA2C;AAK3C,yDAAwD;AACxD,+DAK+B;AAC/B,yEAAmE;AAE5D,MAAM,eAAe,GAAG,CAAC,WAAyB,EAAE,YAAkC,EAAqB,EAAE;IAClH,MAAM,YAAY,GAAG,IAAA,qCAAkB,EAAC,WAAW,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAA,wCAAkB,EAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACtE,MAAM,YAAY,GAAG,IAAA,4CAAsB,EAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACvE,MAAM,mBAAmB,GAAG,IAAA,kDAA4B,EAAC,WAAW,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,IAAA,kDAA4B,EAAC,WAAW,CAAC,CAAC;IAClE,MAAM,kBAAkB,GAAG,IAAA,gDAAqB,EAAC,WAAW,CAAC,CAAC;IAE9D,OAAO;QACL,GAAG,YAAY;QACf,GAAG,eAAe;QAClB,GAAG,YAAY;QACf,GAAG,mBAAmB;QACtB,GAAG,eAAe;QAClB,GAAG,kBAAkB;KACtB,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,eAAe,mBAgB1B"}

package/dist/validators/reference-validator.d.ts

@@ -1,15 +0,0 @@
-import { ParsedFile } from '../parser';
-import { ValidationError } from '../types';
-import { CatalogDependencies } from '../config';
-interface ResourceIndex {
-    [resourceType: string]: {
-        [resourceId: string]: Set<string>;
-    };
-}
-export declare const buildResourceIndex: (parsedFiles: ParsedFile[], dependencies?: CatalogDependencies) => ResourceIndex;
-export declare const validateReferences: (parsedFiles: ParsedFile[], dependencies?: CatalogDependencies) => ValidationError[];
-export declare const validateOrphanMessages: (parsedFiles: ParsedFile[], dependencies?: CatalogDependencies) => ValidationError[];
-export declare const validateDeprecatedReferences: (parsedFiles: ParsedFile[]) => ValidationError[];
-export declare const validateDuplicateResourceIds: (parsedFiles: ParsedFile[]) => ValidationError[];
-export {};
-//# sourceMappingURL=reference-validator.d.ts.map

package/dist/validators/reference-validator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"reference-validator.d.ts","sourceRoot":"","sources":["../../src/validators/reference-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,eAAe,EAAqB,MAAM,UAAU,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAGhD,UAAU,aAAa;IACrB,CAAC,YAAY,EAAE,MAAM,GAAG;QACtB,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;KACnC,CAAC;CACH;AAED,eAAO,MAAM,kBAAkB,GAAI,aAAa,UAAU,EAAE,EAAE,eAAe,mBAAmB,KAAG,aAgDlG,CAAC;AAwMF,eAAO,MAAM,kBAAkB,GAAI,aAAa,UAAU,EAAE,EAAE,eAAe,mBAAmB,KAAG,eAAe,EAsDjH,CAAC;AAGF,eAAO,MAAM,sBAAsB,GAAI,aAAa,UAAU,EAAE,EAAE,eAAe,mBAAmB,KAAG,eAAe,EA0ErH,CAAC;AAGF,eAAO,MAAM,4BAA4B,GAAI,aAAa,UAAU,EAAE,KAAG,eAAe,EA2DvF,CAAC;AAGF,eAAO,MAAM,4BAA4B,GAAI,aAAa,UAAU,EAAE,KAAG,eAAe,EA2BvF,CAAC"}