@eventcatalog/linter/dist/scanner/index.js

A linter for EventCatalog to validate frontmatter and resource references

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.scanCatalogFiles = exports.extractResourceInfo = void 0;
const fast_glob_1 = __importDefault(require("fast-glob"));
const path_1 = __importDefault(require("path"));
const RESOURCE_PATTERNS = {
    domain: [
        'domains/*/index.{md,mdx}',
        'domains/*/versioned/*/index.{md,mdx}',
        'domains/*/subdomains/*/index.{md,mdx}',
        'domains/*/subdomains/*/versioned/*/index.{md,mdx}',
    ],
    service: [
        'domains/*/services/*/index.{md,mdx}',
        'domains/*/services/*/versioned/*/index.{md,mdx}',
        'domains/*/subdomains/*/services/*/index.{md,mdx}',
        'domains/*/subdomains/*/services/*/versioned/*/index.{md,mdx}',
        'services/*/index.{md,mdx}',
        'services/*/versioned/*/index.{md,mdx}',
    ],
    event: ['**/events/*/index.{md,mdx}', '**/events/*/versioned/*/index.{md,mdx}'],
    command: ['**/commands/*/index.{md,mdx}', '**/commands/*/versioned/*/index.{md,mdx}'],
    query: ['**/queries/*/index.{md,mdx}', '**/queries/*/versioned/*/index.{md,mdx}'],
    channel: ['**/channels/*/index.{md,mdx}', '**/channels/*/versioned/*/index.{md,mdx}'],
    flow: ['**/flows/*/index.{md,mdx}', '**/flows/*/versioned/*/index.{md,mdx}'],
    entity: ['**/entities/*/index.{md,mdx}', '**/entities/*/versioned/*/index.{md,mdx}'],
    user: ['users/*.{md,mdx}'],
    team: ['teams/*.{md,mdx}'],
};
const extractResourceInfo = (filePath, resourceType) => {
    // Normalize path separators to forward slashes for consistent parsing across platforms
    const normalizedPath = filePath.replace(/\\/g, '/');
    const relativePath = normalizedPath.split('/');
    if (resourceType === 'user' || resourceType === 'team') {
        const filename = path_1.default.basename(filePath, path_1.default.extname(filePath));
        return { id: filename };
    }
    // Find the resource type directory in the path
    const resourceTypePattern = `${resourceType}s`;
    const resourceTypeIndex = relativePath.findIndex((part) => part === resourceTypePattern);
    if (resourceTypeIndex === -1) {
        // Fallback to original logic if pattern not found
        const parts = relativePath.slice(1, -1);
        return { id: parts[parts.length - 1] };
    }
    // Extract parts after the resource type directory, excluding index.mdx
    const parts = relativePath.slice(resourceTypeIndex + 1, -1);
    if (parts.length === 0) {
        return { id: 'unknown' };
    }
    // Check for versioned structure: resourceId/versioned/version/index.mdx
    if (parts.length >= 3 && parts[parts.length - 2] === 'versioned') {
        const version = parts[parts.length - 1];
        const resourceId = parts.slice(0, -2).join('/');
        return { id: resourceId, version };
    }
    // Check for domain versioned structure: domains/domainId/versioned/version/index.mdx
    if (resourceType === 'domain' && parts.length >= 2) {
        const versionedIndex = parts.findIndex((part) => part === 'versioned');
        if (versionedIndex !== -1 && versionedIndex < parts.length - 1) {
            const version = parts[versionedIndex + 1];
            const resourceId = parts.slice(0, versionedIndex).join('/');
            return { id: resourceId, version };
        }
    }
    // Standard structure: resourceId/index.mdx
    if (parts.length === 1) {
        return { id: parts[0] };
    }
    // Handle subdomain structure or nested resources
    return { id: parts.join('/') };
};
exports.extractResourceInfo = extractResourceInfo;
const scanCatalogFiles = async (rootDir) => {
    const files = [];
    for (const [resourceType, patterns] of Object.entries(RESOURCE_PATTERNS)) {
        const foundFiles = await (0, fast_glob_1.default)(patterns, {
            cwd: rootDir,
            absolute: true,
            onlyFiles: true,
            followSymbolicLinks: false,
        });
        for (const filePath of foundFiles) {
            const relativePath = path_1.default.relative(rootDir, filePath);
            const { id, version } = (0, exports.extractResourceInfo)(relativePath, resourceType);
            files.push({
                path: filePath,
                relativePath,
                resourceType: resourceType,
                resourceId: id,
                version,
            });
        }
    }
    return files;
};
exports.scanCatalogFiles = scanCatalogFiles;
//# sourceMappingURL=index.js.map