@lightdash/cli 0.2192.0 → 0.2193.1

package/dist/handlers/lint.js

@@ -0,0 +1,250 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lintHandler = lintHandler;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const YAML = tslib_1.__importStar(require("yaml"));
+const ajv_1 = require("../ajv");
+const ajvToSarif_1 = require("./lint/ajvToSarif");
+const sarifFormatter_1 = require("./lint/sarifFormatter");
+const validateChartSchema = ajv_1.ajv.compile(common_1.chartAsCodeSchema);
+const validateDashboardSchema = ajv_1.ajv.compile(common_1.dashboardAsCodeSchema);
+/**
+ * Find all YAML and JSON files in a path (file or directory).
+ * If a file path is provided, returns it if it's a .yml/.yaml/.json file.
+ * If a directory path is provided, recursively searches for all such files.
+ */
+function findLightdashCodeFiles(inputPath) {
+    const files = [];
+    // Check if the path is a file or directory
+    const stats = fs.statSync(inputPath);
+    if (stats.isFile()) {
+        // Single file case - check if it's a valid extension
+        const isYaml = inputPath.endsWith('.yml') || inputPath.endsWith('.yaml');
+        const isJson = inputPath.endsWith('.json');
+        if (isYaml || isJson) {
+            files.push(inputPath);
+        }
+        return files;
+    }
+    // Directory case - walk recursively
+    function walk(currentPath) {
+        const entries = fs.readdirSync(currentPath, { withFileTypes: true });
+        for (const entry of entries) {
+            const fullPath = path.join(currentPath, entry.name);
+            if (entry.isDirectory()) {
+                // Skip node_modules, .git, etc.
+                if (!entry.name.startsWith('.') &&
+                    entry.name !== 'node_modules' &&
+                    entry.name !== 'target') {
+                    walk(fullPath);
+                }
+            }
+            else if (entry.isFile()) {
+                const isYaml = entry.name.endsWith('.yml') || entry.name.endsWith('.yaml');
+                const isJson = entry.name.endsWith('.json');
+                if (isYaml || isJson) {
+                    files.push(fullPath);
+                }
+            }
+        }
+    }
+    walk(inputPath);
+    return files;
+}
+/**
+ * Build a map of JSON paths to their line/column positions in the source YAML/JSON file.
+ *
+ * This creates a Map<string, {line, column}> by traversing the YAML Abstract Syntax Tree (AST).
+ * For each YAML node encountered, we store its location keyed by its JSON path (e.g., '/metricQuery/filters').
+ *
+ * IMPORTANT: The map stores locations for ACTUAL YAML KEYS that exist in the file.
+ * It does NOT contain entries for:
+ * - Root path '/' (there's no root key in YAML)
+ * - Missing required properties that don't exist in the file
+ *
+ * @param fileContent - The raw YAML or JSON file content
+ * @param isJson - Whether the file is JSON (true) or YAML (false)
+ * @returns Object containing parsed data and the location map
+ */
+function buildLocationMap(fileContent, isJson) {
+    const locationMap = new Map();
+    if (isJson) {
+        // For JSON, parse normally (location map not populated - could be enhanced later)
+        const data = JSON.parse(fileContent);
+        return { data, locationMap };
+    }
+    // Parse YAML with the 'yaml' package to access the Abstract Syntax Tree (AST)
+    const doc = YAML.parseDocument(fileContent);
+    function traverse(node, jsonPath) {
+        if (!node)
+            return;
+        // Store location for this node
+        if (node.range) {
+            const [start] = node.range;
+            const lines = fileContent.substring(0, start).split('\n');
+            const line = lines.length;
+            const column = lines[lines.length - 1].length + 1;
+            locationMap.set(jsonPath, { line, column });
+        }
+        if (YAML.isMap(node)) {
+            for (const pair of node.items) {
+                if (YAML.isScalar(pair.key)) {
+                    const key = String(pair.key.value);
+                    const childPath = jsonPath
+                        ? `${jsonPath}/${key}`
+                        : `/${key}`;
+                    traverse(pair.value, childPath);
+                }
+            }
+        }
+        else if (YAML.isSeq(node)) {
+            for (let i = 0; i < node.items.length; i += 1) {
+                const childPath = `${jsonPath}/${i}`;
+                traverse(node.items[i], childPath);
+            }
+        }
+    }
+    traverse(doc.contents, '');
+    // Convert to plain JS object for validation
+    const data = doc.toJS();
+    return { data, locationMap };
+}
+/**
+ * Validate a single YAML or JSON file
+ */
+function validateFile(filePath) {
+    try {
+        // Read and parse file
+        const fileContent = fs.readFileSync(filePath, 'utf8');
+        const isJson = filePath.endsWith('.json');
+        const { data, locationMap } = buildLocationMap(fileContent, isJson);
+        if (!data || typeof data !== 'object') {
+            return {
+                filePath,
+                valid: false,
+                // Skip non-object files as they're not lightdash code
+            };
+        }
+        const dataObj = data;
+        // Check if this is a chart (has version and metricQuery)
+        if (dataObj.version === 1 && dataObj.metricQuery && !dataObj.tiles) {
+            const valid = validateChartSchema(data);
+            if (!valid && validateChartSchema.errors) {
+                return {
+                    filePath,
+                    valid: false,
+                    errors: validateChartSchema.errors,
+                    fileContent,
+                    locationMap,
+                    type: 'chart',
+                };
+            }
+            return { filePath, valid: true, type: 'chart' };
+        }
+        // Check if this is a dashboard (has version and tiles)
+        if (dataObj.version === 1 && dataObj.tiles) {
+            const valid = validateDashboardSchema(data);
+            if (!valid && validateDashboardSchema.errors) {
+                return {
+                    filePath,
+                    valid: false,
+                    errors: validateDashboardSchema.errors,
+                    fileContent,
+                    locationMap,
+                    type: 'dashboard',
+                };
+            }
+            return { filePath, valid: true, type: 'dashboard' };
+        }
+        // Not a lightdash code file
+        return {
+            filePath,
+            valid: true, // Don't report non-lightdash files as errors
+        };
+    }
+    catch (error) {
+        // Parsing error - skip this file
+        return {
+            filePath,
+            valid: false,
+        };
+    }
+}
+async function lintHandler(options) {
+    const searchPath = path.resolve(options.path || process.cwd());
+    const outputFormat = options.format || 'cli';
+    // Check if path exists
+    if (!fs.existsSync(searchPath)) {
+        throw new Error(`Path does not exist: ${searchPath}`);
+    }
+    if (outputFormat === 'cli') {
+        console.log(chalk_1.default.dim(`Searching for Lightdash Code files in: ${searchPath}\n`));
+    }
+    // Find all YAML/JSON files
+    const codeFiles = findLightdashCodeFiles(searchPath);
+    if (codeFiles.length === 0) {
+        if (outputFormat === 'cli') {
+            console.log(chalk_1.default.yellow('No YAML/JSON files found in the specified path.'));
+        }
+        return;
+    }
+    if (options.verbose && outputFormat === 'cli') {
+        console.log(chalk_1.default.dim(`Found ${codeFiles.length} YAML/JSON files\n`));
+    }
+    // Validate each file
+    const results = [];
+    for (const file of codeFiles) {
+        const result = validateFile(file);
+        // Only track Lightdash Code files (views, explores, charts, dashboards)
+        if (result.type) {
+            results.push(result);
+        }
+    }
+    if (results.length === 0) {
+        if (outputFormat === 'cli') {
+            console.log(chalk_1.default.yellow('No Lightdash Code files found.'));
+            console.log(chalk_1.default.dim('Charts must have version: 1 + metricQuery, dashboards must have version: 1 + tiles'));
+        }
+        return;
+    }
+    // Convert to SARIF format
+    const invalidResults = results.filter((r) => !r.valid);
+    const validCount = results.length - invalidResults.length;
+    // Build SARIF report from invalid results
+    const sarifResults = invalidResults
+        .filter((r) => r.errors && r.fileContent && r.type)
+        .map((r) => ({
+        filePath: r.filePath,
+        errors: r.errors,
+        fileContent: r.fileContent,
+        locationMap: r.locationMap,
+        schemaType: r.type,
+    }));
+    const sarifLog = (0, ajvToSarif_1.createSarifReport)(sarifResults);
+    // Output based on format
+    if (outputFormat === 'json') {
+        console.log(JSON.stringify(sarifLog, null, 2));
+    }
+    else {
+        // CLI format
+        const summary = (0, sarifFormatter_1.getSarifSummary)(sarifLog);
+        if (!summary.hasErrors) {
+            console.log(chalk_1.default.green('\n✓ All Lightdash Code files are valid!\n'));
+            return;
+        }
+        // Show summary
+        console.log(chalk_1.default.bold(`\nValidated ${results.length} Lightdash Code files:`));
+        console.log(chalk_1.default.green(`  ✓ ${validCount} valid`));
+        console.log(chalk_1.default.red(`  ✗ ${summary.totalFiles} invalid`));
+        // Show formatted errors (starts with newline, so we don't need extra spacing)
+        console.log((0, sarifFormatter_1.formatSarifForCli)(sarifLog, searchPath));
+    }
+    // Exit with error if there were validation failures
+    if (invalidResults.length > 0) {
+        process.exit(1);
+    }
+}

package/dist/index.js

@@ -14,6 +14,7 @@ const diagnostics_1 = require("./handlers/diagnostics");
 const download_1 = require("./handlers/download");
 const generate_1 = require("./handlers/generate");
 const generateExposures_1 = require("./handlers/generateExposures");
+const lint_1 = require("./handlers/lint");
 const login_1 = require("./handlers/login");
 const preview_1 = require("./handlers/preview");
 const renameHandler_1 = require("./handlers/renameHandler");
@@ -373,6 +374,21 @@ ${styles.bold('Examples:')}
     .option('--defer', 'dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.', undefined)
     .option('--no-defer', 'dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.', undefined)
     .action(diagnostics_1.diagnosticsHandler);
+commander_1.program
+    .command('lint')
+    .description('Validates Lightdash Code files (charts, dashboards) against JSON schemas')
+    .addHelpText('after', `
+${styles.bold('Examples:')}
+  ${styles.title('⚡')}️lightdash ${styles.bold('lint')} ${styles.secondary('-- validates all Lightdash Code files in current directory')}
+  ${styles.title('⚡')}️lightdash ${styles.bold('lint')} --path ./chart.yml ${styles.secondary('-- validates a single chart file')}
+  ${styles.title('⚡')}️lightdash ${styles.bold('lint')} --path ./lightdash ${styles.secondary('-- validates files in a specific directory')}
+  ${styles.title('⚡')}️lightdash ${styles.bold('lint')} --verbose ${styles.secondary('-- shows detailed validation output')}
+  ${styles.title('⚡')}️lightdash ${styles.bold('lint')} --format json ${styles.secondary('-- outputs results in SARIF JSON format')}
+`)
+    .option('-p, --path <path>', 'Path to a file or directory to lint (defaults to current directory)', undefined)
+    .option('--verbose', 'Show detailed output', false)
+    .option('-f, --format <format>', 'Output format: cli (default) or json (SARIF format)', 'cli')
+    .action(lint_1.lintHandler);
 const errorHandler = (err) => {
     // Use error message with fallback for safety
     const errorMessage = (0, common_1.getErrorMessage)(err) || 'An unexpected error occurred';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.2192.0",
+  "version": "0.2193.1",
   "license": "MIT",
   "bin": {
     "lightdash": "dist/index.js"
@@ -33,8 +33,9 @@
     "parse-node-version": "^2.0.0",
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
-    "@lightdash/warehouses": "0.2192.0",
-    "@lightdash/common": "0.2192.0"
+    "yaml": "^2.7.0",
+    "@lightdash/warehouses": "0.2193.1",
+    "@lightdash/common": "0.2193.1"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {