@lightdash/cli 0.2191.2 → 0.2193.0

package/dist/ajv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ajv.d.ts","sourceRoot":"","sources":["../src/ajv.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,GAAG,KAAiC,CAAC"}
+{"version":3,"file":"ajv.d.ts","sourceRoot":"","sources":["../src/ajv.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,eAAO,MAAM,GAAG,KAGd,CAAC"}

package/dist/ajv.js

@@ -3,4 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ajv = void 0;
 const tslib_1 = require("tslib");
 const ajv_1 = tslib_1.__importDefault(require("ajv"));
-exports.ajv = new ajv_1.default({ coerceTypes: true });
+const ajv_formats_1 = tslib_1.__importDefault(require("ajv-formats"));
+exports.ajv = new ajv_1.default({
+    coerceTypes: true,
+    allErrors: true, // Report all errors, not just the first one
+});
+(0, ajv_formats_1.default)(exports.ajv);

package/dist/handlers/lint/ajvToSarif.d.ts

@@ -0,0 +1,66 @@
+import type { ErrorObject } from 'ajv';
+type LocationMap = Map<string, {
+    line: number;
+    column: number;
+}>;
+type FileValidationResult = {
+    filePath: string;
+    errors: ErrorObject[];
+    fileContent: string;
+    locationMap?: LocationMap;
+    schemaType: 'chart' | 'dashboard';
+};
+export type SarifLog = {
+    version: '2.1.0';
+    $schema: string;
+    runs: SarifRun[];
+};
+type SarifRun = {
+    tool: {
+        driver: {
+            name: string;
+            version: string;
+            informationUri?: string;
+            rules?: SarifRule[];
+        };
+    };
+    results: SarifResult[];
+};
+type SarifRule = {
+    id: string;
+    shortDescription: {
+        text: string;
+    };
+    fullDescription?: {
+        text: string;
+    };
+    help?: {
+        text: string;
+    };
+};
+export type SarifResult = {
+    ruleId: string;
+    level: 'error' | 'warning' | 'note';
+    message: {
+        text: string;
+    };
+    locations: SarifLocation[];
+    properties?: Record<string, unknown>;
+};
+type SarifLocation = {
+    physicalLocation: {
+        artifactLocation: {
+            uri: string;
+        };
+        region: {
+            startLine: number;
+            startColumn: number;
+        };
+    };
+};
+/**
+ * Convert validation results to SARIF format
+ */
+export declare function createSarifReport(results: FileValidationResult[]): SarifLog;
+export {};
+//# sourceMappingURL=ajvToSarif.d.ts.map

package/dist/handlers/lint/ajvToSarif.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ajvToSarif.d.ts","sourceRoot":"","sources":["../../../src/handlers/lint/ajvToSarif.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAEvC,KAAK,WAAW,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjE,KAAK,oBAAoB,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,UAAU,EAAE,OAAO,GAAG,WAAW,CAAC;CACrC,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,QAAQ,EAAE,CAAC;CACpB,CAAC;AAEF,KAAK,QAAQ,GAAG;IACZ,IAAI,EAAE;QACF,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;SACvB,CAAC;KACL,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CAC1B,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,eAAe,CAAC,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,CAAC,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACpC,OAAO,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,gBAAgB,EAAE;QACd,gBAAgB,EAAE;YACd,GAAG,EAAE,MAAM,CAAC;SACf,CAAC;QACF,MAAM,EAAE;YACJ,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,EAAE,MAAM,CAAC;SACvB,CAAC;KACL,CAAC;CACL,CAAC;AAmJF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAwG3E"}

package/dist/handlers/lint/ajvToSarif.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSarifReport = createSarifReport;
+/**
+ * Find the line and column number in YAML content for a given data path using regex-based search.
+ *
+ * This is a FALLBACK strategy used when the locationMap doesn't have an entry for the error path.
+ * Primary use case: root-level missing required properties (dataPath='/' which isn't in locationMap).
+ *
+ * The function uses regex patterns to search through the YAML content and locate:
+ * - Array items by counting '-' markers
+ * - Nested properties within array items
+ * - Simple top-level keys
+ *
+ * Returns line 1, column 1 if no match is found (used for root-level errors).
+ */
+function findLocationForPath(yamlContent, dataPath) {
+    const lines = yamlContent.split('\n');
+    // Remove leading slash and split path
+    const pathParts = dataPath
+        .replace(/^\//, '')
+        .split('/')
+        .filter((p) => p !== '');
+    if (pathParts.length === 0) {
+        // Error at root level
+        return { line: 1, column: 1 };
+    }
+    // Check if we have an array index in the path (e.g., /dimensions/1/type)
+    let arrayParentKey = null;
+    let arrayIndex = null;
+    let propertyInArray = null;
+    // Look for pattern: parent/index/property
+    if (pathParts.length >= 3) {
+        const secondToLast = pathParts[pathParts.length - 2];
+        if (/^\d+$/.test(secondToLast)) {
+            // We have an array index
+            arrayParentKey = pathParts[pathParts.length - 3];
+            arrayIndex = parseInt(secondToLast, 10);
+            propertyInArray = pathParts[pathParts.length - 1];
+        }
+    }
+    else if (pathParts.length === 2) {
+        const [firstPart, lastPart] = pathParts;
+        if (/^\d+$/.test(lastPart)) {
+            // Path is like /dimensions/1
+            arrayParentKey = firstPart;
+            arrayIndex = parseInt(lastPart, 10);
+        }
+    }
+    // For array items with nested property errors (e.g., /dimensions/1/type)
+    if (arrayParentKey && arrayIndex !== null && propertyInArray) {
+        const parentPattern = new RegExp(`^\\s*${arrayParentKey}\\s*:`);
+        let foundParent = false;
+        let arrayItemCount = 0;
+        let arrayItemStartLine = -1;
+        for (let i = 0; i < lines.length; i += 1) {
+            if (!foundParent && parentPattern.test(lines[i])) {
+                foundParent = true;
+            }
+            else if (foundParent && /^\s*-\s/.test(lines[i])) {
+                if (arrayItemCount === arrayIndex) {
+                    arrayItemStartLine = i;
+                    break;
+                }
+                arrayItemCount += 1;
+            }
+        }
+        // Now find the nested property within this array item
+        if (arrayItemStartLine >= 0) {
+            // Check if property is on the same line as the array marker (e.g., "- id: value")
+            const sameLinePattern = new RegExp(`^\\s*-\\s+${propertyInArray}\\s*:`);
+            if (sameLinePattern.test(lines[arrayItemStartLine])) {
+                const match = lines[arrayItemStartLine].match(/^(\s*-\s+)/);
+                const column = match ? match[1].length + 1 : 1;
+                return { line: arrayItemStartLine + 1, column };
+            }
+            // Otherwise, look for the property on subsequent lines
+            const propPattern = new RegExp(`^\\s*${propertyInArray}\\s*:`);
+            for (let i = arrayItemStartLine + 1; i < Math.min(lines.length, arrayItemStartLine + 20); i += 1) {
+                if (propPattern.test(lines[i])) {
+                    const match = lines[i].match(/^(\s*)/);
+                    const column = match ? match[1].length + 1 : 1;
+                    return { line: i + 1, column };
+                }
+                if (/^\s*-\s/.test(lines[i])) {
+                    break;
+                }
+            }
+        }
+    }
+    // Simple search for the last key in the path
+    const lastPart = pathParts[pathParts.length - 1];
+    if (!/^\d+$/.test(lastPart)) {
+        const keyPattern = new RegExp(`^\\s*${lastPart}\\s*:`);
+        for (let i = 0; i < lines.length; i += 1) {
+            if (keyPattern.test(lines[i])) {
+                const match = lines[i].match(/^(\s*)/);
+                const column = match ? match[1].length + 1 : 1;
+                return { line: i + 1, column };
+            }
+        }
+    }
+    return { line: 1, column: 1 };
+}
+/**
+ * Get a friendly error message for an AJV error
+ */
+function getFriendlyMessage(error) {
+    if (error.keyword === 'required' && error.params.missingProperty) {
+        return `Missing required property '${error.params.missingProperty}'`;
+    }
+    if (error.keyword === 'additionalProperties' &&
+        error.params.additionalProperty) {
+        return `Property '${error.params.additionalProperty}' is not allowed`;
+    }
+    if (error.keyword === 'type') {
+        return `Expected type '${error.params.type}'`;
+    }
+    if (error.keyword === 'enum' && error.params.allowedValues) {
+        return `Value must be one of: ${error.params.allowedValues.join(', ')}`;
+    }
+    if (error.keyword === 'const') {
+        return `Value must be '${error.params.allowedValue}'`;
+    }
+    return error.message || 'Validation error';
+}
+/**
+ * Convert validation results to SARIF format
+ */
+function createSarifReport(results) {
+    const sarifResults = [];
+    const rules = new Map();
+    for (const result of results) {
+        for (const error of result.errors) {
+            // For additionalProperties errors, append the property name to the path
+            // Handle root-level errors carefully to avoid double slashes (//propertyName)
+            let dataPath = error.instancePath || '/';
+            if (error.keyword === 'additionalProperties' &&
+                error.params.additionalProperty) {
+                dataPath =
+                    dataPath === '/'
+                        ? `/${error.params.additionalProperty}`
+                        : `${dataPath}/${error.params.additionalProperty}`;
+            }
+            // Determine error location using a two-strategy approach:
+            // 1. PRIMARY: Use locationMap (built from YAML AST during parsing)
+            //    - Fast O(1) lookup for ~95% of cases
+            //    - Works for: additional properties, type errors, enum errors, nested errors, array items
+            //    - Works for: nested missing required fields (e.g., missing 'exploreName' in 'metricQuery')
+            //
+            // 2. FALLBACK: Use regex-based search when locationMap lookup fails
+            //    - Needed for: root-level missing required properties (e.g., missing 'name', 'version')
+            //      These have dataPath='/' which doesn't exist in locationMap since it stores actual YAML keys
+            //    - Also provides defensive error handling if AST traversal misses any edge cases
+            let location = null;
+            if (result.locationMap) {
+                location = result.locationMap.get(dataPath) || null;
+            }
+            if (!location) {
+                // Fallback to regex search - primarily for root-level missing required properties
+                location = findLocationForPath(result.fileContent, dataPath);
+            }
+            const message = getFriendlyMessage(error);
+            const ruleId = `${result.schemaType}/${error.keyword}`;
+            // Add rule if we haven't seen it before
+            if (!rules.has(ruleId)) {
+                rules.set(ruleId, {
+                    id: ruleId,
+                    shortDescription: {
+                        text: `${error.keyword} validation error`,
+                    },
+                });
+            }
+            const sarifResult = {
+                ruleId,
+                level: 'error',
+                message: {
+                    text: message,
+                },
+                locations: [
+                    {
+                        physicalLocation: {
+                            artifactLocation: {
+                                uri: result.filePath,
+                            },
+                            region: {
+                                startLine: location?.line || 1,
+                                startColumn: location?.column || 1,
+                            },
+                        },
+                    },
+                ],
+            };
+            // Add additional context
+            if (error.params) {
+                const properties = {};
+                Object.entries(error.params).forEach(([key, value]) => {
+                    properties[key] = value;
+                });
+                sarifResult.properties = { errorParams: properties };
+            }
+            sarifResults.push(sarifResult);
+        }
+    }
+    return {
+        version: '2.1.0',
+        $schema: 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json',
+        runs: [
+            {
+                tool: {
+                    driver: {
+                        name: 'lightdash-lint',
+                        version: '1.0.0',
+                        informationUri: 'https://github.com/lightdash/lightdash',
+                        rules: Array.from(rules.values()),
+                    },
+                },
+                results: sarifResults,
+            },
+        ],
+    };
+}

package/dist/handlers/lint/sarifFormatter.d.ts

@@ -0,0 +1,14 @@
+import type { SarifLog } from './ajvToSarif';
+/**
+ * Format SARIF results for CLI output
+ */
+export declare function formatSarifForCli(sarifLog: SarifLog, searchPath: string): string;
+/**
+ * Get summary statistics from SARIF log
+ */
+export declare function getSarifSummary(sarifLog: SarifLog): {
+    totalFiles: number;
+    totalErrors: number;
+    hasErrors: boolean;
+};
+//# sourceMappingURL=sarifFormatter.d.ts.map

package/dist/handlers/lint/sarifFormatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sarifFormatter.d.ts","sourceRoot":"","sources":["../../../src/handlers/lint/sarifFormatter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAe,MAAM,cAAc,CAAC;AAgC1D;;GAEG;AACH,wBAAgB,iBAAiB,CAC7B,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,GACnB,MAAM,CA2ER;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;CACtB,CAsBA"}

package/dist/handlers/lint/sarifFormatter.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatSarifForCli = formatSarifForCli;
+exports.getSarifSummary = getSarifSummary;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+/**
+ * Get a snippet of the file around the error location
+ */
+function getCodeSnippet(filePath, line, contextLines = 2) {
+    try {
+        const content = fs.readFileSync(filePath, 'utf8');
+        const lines = content.split('\n');
+        const startLine = Math.max(0, line - 1 - contextLines);
+        const endLine = Math.min(lines.length, line + contextLines);
+        return lines
+            .slice(startLine, endLine)
+            .map((lineText, idx) => {
+            const lineNum = startLine + idx + 1;
+            const prefix = lineNum === line ? '→ ' : '  ';
+            return `${prefix}${lineNum
+                .toString()
+                .padStart(3, ' ')} | ${lineText}`;
+        })
+            .join('\n');
+    }
+    catch {
+        return '';
+    }
+}
+/**
+ * Format SARIF results for CLI output
+ */
+function formatSarifForCli(sarifLog, searchPath) {
+    const output = [];
+    if (!sarifLog.runs || sarifLog.runs.length === 0) {
+        return chalk_1.default.green('\n✓ All Lightdash Code files are valid!\n');
+    }
+    const run = sarifLog.runs[0];
+    const results = run.results || [];
+    if (results.length === 0) {
+        return chalk_1.default.green('\n✓ All Lightdash Code files are valid!\n');
+    }
+    // Group results by file
+    const resultsByFile = new Map();
+    for (const result of results) {
+        const location = result.locations?.[0];
+        const uri = location?.physicalLocation?.artifactLocation?.uri;
+        if (uri) {
+            if (!resultsByFile.has(uri)) {
+                resultsByFile.set(uri, []);
+            }
+            resultsByFile.get(uri).push(result);
+        }
+    }
+    // Count stats
+    const totalFiles = resultsByFile.size;
+    output.push(chalk_1.default.red('\nValidation Errors:\n'));
+    // Format each file's errors
+    for (const [fileUri, fileResults] of resultsByFile.entries()) {
+        const relativePath = path.relative(searchPath, fileUri);
+        output.push(chalk_1.default.red.bold(`\n✗ ${relativePath}`));
+        for (const result of fileResults) {
+            const message = result.message.text;
+            const location = result.locations?.[0]?.physicalLocation;
+            const line = location?.region?.startLine;
+            const column = location?.region?.startColumn;
+            output.push(chalk_1.default.red(`\n  ${message}${line ? ` (line ${line})` : ''}`));
+            // Add clickable file link for IDEs
+            if (line) {
+                // Encode the URI properly for file:// protocol to handle special characters (#, ?, &, spaces, etc.)
+                const encodedPath = encodeURI(fileUri);
+                const fileLink = `file://${encodedPath}:${line}${column ? `:${column}` : ''}`;
+                output.push(chalk_1.default.dim(`  ${fileLink}`));
+            }
+            if (line && fs.existsSync(fileUri)) {
+                const snippet = getCodeSnippet(fileUri, line);
+                if (snippet) {
+                    output.push(chalk_1.default.dim(`\n${snippet}\n`));
+                }
+            }
+        }
+    }
+    output.push(chalk_1.default.red(`\nValidation failed for ${totalFiles} file${totalFiles > 1 ? 's' : ''}`));
+    return output.join('\n');
+}
+/**
+ * Get summary statistics from SARIF log
+ */
+function getSarifSummary(sarifLog) {
+    if (!sarifLog.runs || sarifLog.runs.length === 0) {
+        return { totalFiles: 0, totalErrors: 0, hasErrors: false };
+    }
+    const run = sarifLog.runs[0];
+    const results = run.results || [];
+    const uniqueFiles = new Set();
+    for (const result of results) {
+        const location = result.locations?.[0];
+        const uri = location?.physicalLocation?.artifactLocation?.uri;
+        if (uri) {
+            uniqueFiles.add(uri);
+        }
+    }
+    return {
+        totalFiles: uniqueFiles.size,
+        totalErrors: results.length,
+        hasErrors: results.length > 0,
+    };
+}

package/dist/handlers/lint.d.ts

@@ -0,0 +1,8 @@
+type LintOptions = {
+    path?: string;
+    verbose?: boolean;
+    format?: 'cli' | 'json';
+};
+export declare function lintHandler(options: LintOptions): Promise<void>;
+export {};
+//# sourceMappingURL=lint.d.ts.map

package/dist/handlers/lint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/handlers/lint.ts"],"names":[],"mappings":"AAUA,KAAK,WAAW,GAAG;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC3B,CAAC;AAgNF,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAmGrE"}