@salesforce-ux/slds-linter 0.1.4-alpha.1 → 0.1.4-alpha.3

package/build/commands/report.js

@@ -8,10 +8,10 @@ import { Logger } from "../utils/logger.js";
 import { FileScanner } from "../services/file-scanner.js";
 import { StyleFilePatterns, ComponentFilePatterns } from "../services/file-patterns.js";
 import { LintRunner } from "../services/lint-runner.js";
-import { ReportGenerator } from "../services/report-generator.js";
+import { ReportGenerator, CsvReportGenerator } from "../services/report-generator.js";
 import { DEFAULT_ESLINT_CONFIG_PATH, DEFAULT_STYLELINT_CONFIG_PATH, LINTER_CLI_VERSION } from "../services/config.resolver.js";
 function registerReportCommand(program) {
-  program.command("report").description("Generate SARIF report from linting results").argument("[directory]", "Target directory to scan (defaults to current directory). Support glob patterns").addOption(new Option("-d, --directory <path>", "Target directory to scan (defaults to current directory). Support glob patterns").hideHelp()).option("-o, --output <path>", "Output directory for reports (defaults to current directory)").option("--config-stylelint <path>", "Path to stylelint config file").option("--config-eslint <path>", "Path to eslint config file").action(async (directory, options) => {
+  program.command("report").description("Generate report from linting results").argument("[directory]", "Target directory to scan (defaults to current directory). Support glob patterns").addOption(new Option("-d, --directory <path>", "Target directory to scan (defaults to current directory). Support glob patterns").hideHelp()).option("-o, --output <path>", "Output directory for reports (defaults to current directory)").option("--config-stylelint <path>", "Path to stylelint config file").option("--config-eslint <path>", "Path to eslint config file").addOption(new Option("--format <type>", "Output format").choices(["sarif", "csv"]).default("sarif")).action(async (directory, options) => {
     const spinner = ora("Starting report generation...");
     try {
       const normalizedOptions = normalizeCliOptions(options, {
@@ -23,8 +23,7 @@ function registerReportCommand(program) {
       } else if (options.directory) {
         Logger.newLine().warning(chalk.yellow(
           `WARNING: --directory, -d option is deprecated. Supply as argument instead.
-Example: npx @salesforce-ux/slds-linter report ${options.directory}
-`
+            Example: npx @salesforce-ux/slds-linter report ${options.directory}`
         ));
       }
       spinner.start();
@@ -44,20 +43,30 @@ Example: npx @salesforce-ux/slds-linter report ${options.directory}
       const componentResults = await LintRunner.runLinting(componentFileBatches, "component", {
         configPath: normalizedOptions.configEslint
       });
-      spinner.text = "Generating SARIF report...";
-      const combinedReportPath = path.join(normalizedOptions.output, "slds-linter-report.sarif");
-      await ReportGenerator.generateSarifReport([...styleResults, ...componentResults], {
-        outputPath: combinedReportPath,
-        toolName: "slds-linter",
-        toolVersion: LINTER_CLI_VERSION
-      });
-      spinner.succeed("Report generation completed");
-      Logger.success(`SARIF report generated: ${combinedReportPath}
+      const reportFormat = options.format.toLowerCase();
+      if (reportFormat === "sarif") {
+        spinner.text = "Generating SARIF report...";
+        const combinedReportPath = path.join(normalizedOptions.output, "slds-linter-report.sarif");
+        await ReportGenerator.generateSarifReport([...styleResults, ...componentResults], {
+          outputPath: combinedReportPath,
+          toolName: "slds-linter",
+          toolVersion: LINTER_CLI_VERSION
+        });
+        Logger.success(`SARIF report generated: ${combinedReportPath}
+`);
+      } else if (reportFormat === "csv") {
+        spinner.text = "Generating CSV report...";
+        const csvReportPath = await CsvReportGenerator.generate([...styleResults, ...componentResults]);
+        Logger.success(`CSV report generated: ${csvReportPath}
 `);
+      } else {
+        throw new Error(`Invalid format: ${reportFormat}. Supported formats: sarif, csv`);
+      }
+      spinner.succeed("Report generation completed");
       process.exit(0);
     } catch (error) {
       spinner?.fail("Report generation failed");
-      Logger.error(`Failed to generate SARIF report: ${error.message}`);
+      Logger.error(`Failed to generate report: ${error.message}`);
       process.exit(1);
     }
   });

package/build/index.js

@@ -19,7 +19,7 @@ process.on("uncaughtException", (error) => {
 var program = new Command();
 program.name("npx @salesforce-ux/slds-linter@latest").showHelpAfterError();
 function registerVersion() {
-  program.description("SLDS Linter CLI tool for linting styles and components").version("0.1.4-alpha.1");
+  program.description("SLDS Linter CLI tool for linting styles and components").version("0.1.4-alpha.3");
 }
 registerLintCommand(program);
 registerReportCommand(program);

package/build/services/config.resolver.js

@@ -5,7 +5,7 @@ var DEFAULT_ESLINT_CONFIG_PATH = resolvePath("@salesforce-ux/eslint-plugin-slds/
 var DEFAULT_STYLELINT_CONFIG_PATH = resolvePath("@salesforce-ux/stylelint-plugin-slds/.stylelintrc.yml", import.meta);
 var STYLELINT_VERSION = "16.14.1";
 var ESLINT_VERSION = "8.57.1";
-var LINTER_CLI_VERSION = "0.1.4-alpha.1";
+var LINTER_CLI_VERSION = "0.1.4-alpha.3";
 var getRuleDescription = (ruleId) => {
   const ruleIdWithoutNameSpace = `${ruleId}`.replace(/\@salesforce-ux\//, "");
   return ruleMetadata(ruleIdWithoutNameSpace)?.ruleDesc || "--";

package/build/services/report-generator.d.ts

@@ -18,3 +18,6 @@ export declare class ReportGenerator {
      */
     private static addResultsToSarif;
 }
+export declare class CsvReportGenerator {
+    static generate(results: any[]): Promise<string>;
+}

package/build/services/report-generator.js

@@ -1,6 +1,7 @@
 // src/services/report-generator.ts
 import path from "path";
-import fs from "fs/promises";
+import fs, { writeFile } from "fs/promises";
+import { mkConfig, generateCsv, asString } from "export-to-csv";
 import { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } from "node-sarif-builder";
 import { createWriteStream } from "fs";
 import { JsonStreamStringify } from "json-stream-stringify";
@@ -82,7 +83,7 @@ var ReportGenerator = class {
         ruleId: replaceNamespaceinRules(error.ruleId),
         level: "error",
         messageText: error.message,
-        fileUri: lintResult.filePath,
+        fileUri: path.relative(process.cwd(), lintResult.filePath),
         startLine: error.line,
         startColumn: error.column,
         endLine: error.line,
@@ -95,7 +96,7 @@ var ReportGenerator = class {
         ruleId: replaceNamespaceinRules(warning.ruleId),
         level: "warning",
         messageText: warning.message,
-        fileUri: lintResult.filePath,
+        fileUri: path.relative(process.cwd(), lintResult.filePath),
         startLine: warning.line,
         startColumn: warning.column,
         endLine: warning.line,
@@ -105,6 +106,55 @@ var ReportGenerator = class {
     }
   }
 };
+var CsvReportGenerator = class {
+  static async generate(results) {
+    const csvConfig = mkConfig({
+      filename: "slds-linter-report",
+      fieldSeparator: ",",
+      quoteStrings: true,
+      decimalSeparator: ".",
+      useTextFile: false,
+      useBom: true,
+      useKeysAsHeaders: true
+    });
+    const cwd = process.cwd();
+    const transformedResults = results.flatMap(
+      (result) => [
+        ...result.errors.map((error) => ({
+          "File Path": path.relative(cwd, result.filePath),
+          "Message": error.message,
+          "Severity": "error",
+          "Rule ID": replaceNamespaceinRules(error.ruleId || "N/A"),
+          "Start Line": error.line,
+          "Start Column": error.column,
+          "End Line": error.endLine || error.line,
+          // Default to start line if missing
+          "End Column": error.endColumn || error.column
+          // Default to start column if missing
+        })),
+        ...result.warnings.map((warning) => ({
+          "File Path": path.relative(cwd, result.filePath),
+          "Message": warning.message,
+          "Severity": "warning",
+          "Rule ID": replaceNamespaceinRules(warning.ruleId || "N/A"),
+          "Start Line": warning.line,
+          "Start Column": warning.column,
+          "End Line": warning.endLine || warning.line,
+          // Default to start line if missing
+          "End Column": warning.endColumn || warning.column
+          // Default to start column if missing
+        }))
+      ]
+    );
+    const csvData = generateCsv(csvConfig)(transformedResults);
+    const csvString = asString(csvData);
+    const csvReportPath = path.join(cwd, `${csvConfig.filename}.csv`);
+    return writeFile(csvReportPath, csvString).then(() => {
+      return csvReportPath;
+    });
+  }
+};
 export {
+  CsvReportGenerator,
   ReportGenerator
 };

package/build/types/index.d.ts

@@ -5,6 +5,7 @@ export interface CliOptions {
     configStylelint?: string;
     configEslint?: string;
     editor?: string;
+    format?: string;
 }
 export interface LintResult {
     filePath: string;

package/build/utils/cli-args.js

@@ -29,6 +29,7 @@ function normalizeCliOptions(options, defultOptions = {}) {
     editor: "vscode",
     configStylelint: "",
     configEslint: "",
+    format: "sarif",
     ...defultOptions,
     ...options,
     directory: nomalizeDirPath(options.directory),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "0.1.4-alpha.1",
+  "version": "0.1.4-alpha.3",
   "description": "SLDS Linter CLI tool for linting styles and components",
   "keywords": [
     "lightning design system linter",
@@ -20,13 +20,14 @@
     "slds-linter": "./build/index.js"
   },
   "dependencies": {
-    "@salesforce-ux/eslint-plugin-slds": "0.1.4-alpha.1",
-    "@salesforce-ux/stylelint-plugin-slds": "0.1.4-alpha.1",
+    "@salesforce-ux/eslint-plugin-slds": "0.1.4-alpha.3",
+    "@salesforce-ux/stylelint-plugin-slds": "0.1.4-alpha.3",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "chalk": "^4.1.2",
     "commander": "^13.1.0",
     "eslint": "^8.0.0",
+    "export-to-csv": "^1.4.0",
     "globby": "^14.1.0",
     "import-meta-resolve": "^4.1.0",
     "json-stream-stringify": "^3.1.6",