@salesforce-ux/slds-linter 1.1.0 → 1.2.0

package/build/commands/lint.js

@@ -27,7 +27,7 @@ function registerLintCommand(program) {
         ));
       }
       const lintResults = await lint(normalizedOptions);
-      const { totalErrors } = printLintResults(lintResults, normalizedOptions.editor);
+      const { totalErrors } = printLintResults(lintResults, { editor: normalizedOptions.editor });
       const elapsedTime = ((Date.now() - startTime) / 1e3).toFixed(2);
       Logger.newLine().success(`Linting completed in ${elapsedTime} seconds.`);
       process.exit(totalErrors > 0 ? 1 : 0);

package/build/executor/index.d.ts

@@ -17,4 +17,13 @@ export declare function lint(config: LintConfig): Promise<LintResult[]>;
  * @throws Error if report generation fails
  */
 export declare function report(config: ReportConfig, results?: LintResult[]): Promise<Readable>;
+/**
+ * This function supports user to supply array of files to be linted
+ *
+ * @param files Array of file paths to be linted
+ * @param config Linting configuration options
+ * @returns Promise resolving to an array of lint results
+ * @throws Error if linting fails or if any file is not found
+ */
+export declare function lintFiles(files: string[], config: LintConfig): Promise<LintResult[]>;
 export type { LintResult, LintResultEntry, LintConfig, ReportConfig, ExitCode, WorkerResult, SarifResultEntry } from '../types';

package/build/executor/index.js

@@ -69,7 +69,31 @@ async function report(config, results) {
     throw new Error(errorMessage);
   }
 }
+async function lintFiles(files, config) {
+  try {
+    Logger.debug("Starting linting with Node API");
+    const normalizedConfig = normalizeCliOptions(config, {
+      configEslint: DEFAULT_ESLINT_CONFIG_PATH
+    });
+    const batches = FileScanner.createBatches(files, FileScanner.DEFAULT_BATCH_SIZE);
+    Logger.debug(
+      `Found ${files.length} files, split into ${batches.length} batches`
+    );
+    const results = await LintRunner.runLinting(batches, {
+      fix: normalizedConfig.fix,
+      configPath: normalizedConfig.configEslint,
+      // when linting files, use the directory of the files as the working directory
+      cwd: normalizedConfig.directory
+    });
+    return results;
+  } catch (error) {
+    const errorMessage = `Linting failed: ${error.message}`;
+    Logger.error(errorMessage);
+    throw new Error(errorMessage);
+  }
+}
 export {
   lint,
+  lintFiles,
   report
 };

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("1.1.0");
+  program.description("SLDS Linter CLI tool for linting styles and components").version("1.2.0");
 }
 registerLintCommand(program);
 registerReportCommand(program);

package/build/services/config.resolver.js

@@ -3,7 +3,7 @@ import { resolvePath } from "../utils/nodeVersionUtil.js";
 import ruleMessages from "@salesforce-ux/eslint-plugin-slds/rule-messages";
 var DEFAULT_ESLINT_CONFIG_PATH = resolvePath("@salesforce-ux/eslint-plugin-slds/config", import.meta);
 var ESLINT_VERSION = "9.36.0";
-var LINTER_CLI_VERSION = "1.1.0";
+var LINTER_CLI_VERSION = "1.2.0";
 var getRuleDescription = (ruleId) => {
   const ruleIdWithoutNameSpace = `${ruleId}`.replace(/\@salesforce-ux\//, "").replace(/^slds\//, "");
   return ruleMessages[ruleIdWithoutNameSpace]?.description || "--";

package/build/services/file-scanner.d.ts

@@ -1,6 +1,6 @@
 import { ScanOptions, ScanResult } from "../types";
 export declare class FileScanner {
-    private static DEFAULT_BATCH_SIZE;
+    static DEFAULT_BATCH_SIZE: number;
     /**
      * Scans directory for files matching the given patterns
      * @param directory Base directory to scan
@@ -15,5 +15,5 @@ export declare class FileScanner {
     /**
      * Splits array of files into batches
      */
-    private static createBatches;
+    static createBatches(files: string[], batchSize: number): string[][];
 }

package/build/services/lint-runner.js

@@ -18,7 +18,8 @@ var LintRunner = class {
       const configPath = await ConfigLoader.processConfig(options.configPath);
       const workerConfig = {
         configPath,
-        fix: options.fix
+        fix: options.fix,
+        cwd: options.cwd
       };
       const results = await BatchProcessor.processBatches(
         fileBatches,

package/build/services/report-generator.js

@@ -6,7 +6,7 @@ import { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } f
 import { createWriteStream } from "fs";
 import { JsonStreamStringify } from "json-stream-stringify";
 import { getRuleDescription } from "./config.resolver.js";
-import { parseText, replaceNamespaceinRules, transformedResults } from "../utils/lintResultsUtil.js";
+import { replaceNamespaceinRules, toCSVRow, toSarifResult } from "../utils/lintResultsUtil.js";
 import { processArtifacts } from "./artifact-processor.js";
 var ReportGenerator = class {
   /**
@@ -97,7 +97,7 @@ var ReportGenerator = class {
    */
   static addResultsToSarif(runBuilder, lintResult) {
     lintResult.messages.forEach((message) => {
-      const resultBuilder = new SarifResultBuilder().initSimple(transformedResults(lintResult, message, "error"));
+      const resultBuilder = new SarifResultBuilder().initSimple(toSarifResult(lintResult, message));
       runBuilder.addResult(resultBuilder);
     });
   }
@@ -123,7 +123,6 @@ var CsvReportGenerator = class {
    * Convert lint results to CSV-compatible data format
    */
   static convertResultsToCsvData(results) {
-    const cwd = process.cwd();
     const csvConfig = mkConfig({
       fieldSeparator: ",",
       quoteStrings: true,
@@ -132,24 +131,13 @@ var CsvReportGenerator = class {
       useBom: true,
       useKeysAsHeaders: true
     });
-    const transformedResults2 = [];
+    const transformedResults = [];
     results.forEach((result) => {
       result.messages.forEach((message) => {
-        transformedResults2.push({
-          "File Path": path.relative(cwd, result.filePath),
-          "Message": parseText(message.message),
-          "Severity": "error",
-          "Rule ID": replaceNamespaceinRules(message.ruleId || "N/A"),
-          "Start Line": message.line,
-          "Start Column": message.column,
-          "End Line": message.endLine || message.line,
-          // Default to start line if missing
-          "End Column": message.endColumn || message.column
-          // Default to start column if missing
-        });
+        transformedResults.push(toCSVRow(result, message));
       });
     });
-    return generateCsv(csvConfig)(transformedResults2);
+    return generateCsv(csvConfig)(transformedResults);
   }
 };
 export {

package/build/types/index.d.ts

@@ -27,18 +27,17 @@ export interface LintConfig extends BaseConfig {
 export interface ReportConfig extends BaseConfig {
     format?: 'sarif' | 'csv';
 }
-export interface LintRunnerOptions {
-    fix?: boolean;
-    configPath?: string;
-    maxWorkers?: number;
-    timeoutMs?: number;
-}
 export type LintResultEntry = Linter.LintMessage;
 export type LintResult = ESLint.LintResult;
 export type ExitCode = 0 | 1 | 2;
 export interface WorkerConfig {
     configPath?: string;
     fix?: boolean;
+    cwd?: string;
+}
+export interface LintRunnerOptions extends WorkerConfig {
+    maxWorkers?: number;
+    timeoutMs?: number;
 }
 export interface WorkerResult {
     filePath: string;
@@ -74,3 +73,17 @@ export interface ScanResult {
     filesCount: number;
     batches: string[][];
 }
+export interface PrintOptions {
+    editor?: string;
+    cwd?: string;
+}
+export interface CsvRowEntry {
+    "File Path": string;
+    "Message": string;
+    "Severity": string;
+    "Rule ID": string;
+    "Start Line": number;
+    "Start Column": number;
+    "End Line": number;
+    "End Column": number;
+}

package/build/utils/lintResultsUtil.d.ts

@@ -1,4 +1,4 @@
-import { LintResult, LintResultEntry, SarifResultEntry, LintResultSummary } from '../types';
+import { LintResult, LintResultEntry, SarifResultEntry, LintResultSummary, PrintOptions, CsvRowEntry } from '../types';
 /**
  *
  * @param id - Rule id
@@ -17,5 +17,6 @@ export declare function parseText(text: string): string;
  * @param results - Array of lint results.
  * @param editor - The chosen editor for clickable links (e.g., "vscode", "atom", "sublime"). If not provided, will auto-detect.
  */
-export declare function printLintResults(results: LintResult[], editor?: string): LintResultSummary;
-export declare function transformedResults(lintResult: LintResult, entry: LintResultEntry, level: 'error' | 'warning'): SarifResultEntry;
+export declare function printLintResults(results: LintResult[], options?: PrintOptions): LintResultSummary;
+export declare function toSarifResult(lintResult: LintResult, entry: LintResultEntry): SarifResultEntry;
+export declare function toCSVRow(lintResult: LintResult, entry: LintResultEntry): CsvRowEntry;

package/build/utils/lintResultsUtil.js

@@ -4,7 +4,7 @@ import { createClickableLineCol } from "./editorLinkUtil.js";
 import { Logger } from "../utils/logger.js";
 import { Colors } from "./colors.js";
 function replaceNamespaceinRules(id) {
-  return id.includes("@salesforce-ux/") ? id.replace("@salesforce-ux/", "") : id;
+  return id?.replace("@salesforce-ux/", "") ?? "N/A";
 }
 function parseText(text) {
   let safeText = text;
@@ -44,7 +44,7 @@ function printFixableViolationsSummary(fixableErrors, fixableWarnings) {
   }
   console.log(`  ${fixableBreakdown.join(" and ")} potentially fixable with the \`--fix\` option.`);
 }
-function printLintResults(results, editor) {
+function printLintResults(results, options) {
   let totalErrors = 0;
   let totalWarnings = 0;
   let fixableErrors = 0;
@@ -52,7 +52,7 @@ function printLintResults(results, editor) {
   results.forEach((result) => {
     if (!result.messages || result.messages.length === 0) return;
     const absolutePath = result.filePath || "";
-    const relativeFile = path.relative(process.cwd(), absolutePath) || "Unknown file";
+    const relativeFile = path.relative(options?.cwd || process.cwd(), absolutePath) || "Unknown file";
     console.log(`
 ${Colors.info.underline(relativeFile)}
 `);
@@ -68,7 +68,7 @@ ${Colors.info.underline(relativeFile)}
         if (msg.fix) fixableWarnings++;
       }
       const lineCol = msg.line && msg.column ? `${msg.line}:${msg.column}` : "-";
-      const clickableLineCol = msg.line && msg.column ? createClickableLineCol(lineCol, absolutePath, msg.line, msg.column, editor) : lineCol;
+      const clickableLineCol = msg.line && msg.column ? createClickableLineCol(lineCol, absolutePath, msg.line, msg.column, options?.editor) : lineCol;
       const severityText = isError ? Colors.error("error") : Colors.warning("warning");
       const message = parseText(msg.message);
       const ruleId = msg.ruleId ? Colors.lowEmphasis(replaceNamespaceinRules(msg.ruleId)) : "";
@@ -90,21 +90,37 @@ ${Colors.info.underline(relativeFile)}
   }
   return { totalErrors, totalWarnings, fixableErrors, fixableWarnings };
 }
-function transformedResults(lintResult, entry, level) {
+function getLevel(severity) {
+  return severity === 2 ? "error" : "warning";
+}
+function toSarifResult(lintResult, entry) {
   return {
     ruleId: replaceNamespaceinRules(entry.ruleId),
-    level,
+    level: getLevel(entry.severity),
     messageText: parseText(entry.message),
     fileUri: path.relative(process.cwd(), lintResult.filePath),
     startLine: entry.line,
     startColumn: entry.column,
-    endLine: entry.line,
-    endColumn: entry.endColumn
+    endLine: entry.endLine || entry.line,
+    endColumn: entry.endColumn || entry.column
+  };
+}
+function toCSVRow(lintResult, entry) {
+  return {
+    "File Path": path.relative(process.cwd(), lintResult.filePath),
+    "Message": parseText(entry.message),
+    "Severity": getLevel(entry.severity),
+    "Rule ID": replaceNamespaceinRules(entry.ruleId),
+    "Start Line": entry.line,
+    "Start Column": entry.column,
+    "End Line": entry.endLine || entry.line,
+    "End Column": entry.endColumn || entry.column
   };
 }
 export {
   parseText,
   printLintResults,
   replaceNamespaceinRules,
-  transformedResults
+  toCSVRow,
+  toSarifResult
 };

package/build/workers/eslint.worker.js

@@ -6,10 +6,14 @@ var ESLintWorker = class extends BaseWorker {
   eslint;
   constructor() {
     super();
-    this.eslint = new ESLint({
+    const linterOptions = {
       overrideConfigFile: this.task.config.configPath,
       fix: this.task.config.fix
-    });
+    };
+    if ("cwd" in this.task.config) {
+      linterOptions.cwd = this.task.config.cwd;
+    }
+    this.eslint = new ESLint(linterOptions);
   }
   async processFile(filePath) {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "SLDS Linter CLI tool for linting styles and components",
   "keywords": [
     "lightning design system linter",
@@ -29,7 +29,7 @@
   ],
   "bin": "build/index.js",
   "dependencies": {
-    "@salesforce-ux/eslint-plugin-slds": "1.1.0",
+    "@salesforce-ux/eslint-plugin-slds": "1.2.0",
     "@typescript-eslint/eslint-plugin": "^8.36.0",
     "@typescript-eslint/parser": "^8.36.0",
     "chalk": "^4.1.2",