@salesforce-ux/slds-linter 0.2.2 → 0.3.1-internal-beta.0

package/README.md

@@ -102,7 +102,7 @@ These options are available on SLDS Linter commands.
 | `--fix`                  | Automatically fix problems                                                   | `lint`         |
 | `--config-stylelint <path>`  | Path to stylelint config file             | `lint`, `report`|
 | `--config-eslint <path>` | Path to eslint config file                    | `lint`, `report`|
-| `--editor <editor>`      | Editor to open files with (e.g., vscode, atom, sublime). Defaults to vscode | `lint` |
+| `--editor <editor>`      | Editor to open files with (e.g., vscode, atom, sublime). Auto-detects if not specified | `lint` |
 | `--format <type>`        | Output format (sarif, csv). Defaults to sarif | `report` |
 
 To view help for these options, add `--help` to each command. For example, run `npx @salesforce-ux/slds-linter lint --help` to see which options you can use with `lint`.

package/build/commands/lint.js

@@ -11,7 +11,7 @@ function registerLintCommand(program) {
     commandUsage: () => {
       return `${program.name()} lint [directory] [options]`;
     }
-  }).description("Run both style and component linting").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("--fix", "Automatically fix problems").option("--config-stylelint <path>", "Path to stylelint config file").option("--config-eslint <path>", "Path to eslint config file").option("--editor <editor>", "Editor to open files with (e.g., vscode, atom, sublime). Defaults to vscode", "vscode").action(async (directory, options) => {
+  }).description("Run both style and component linting").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("--fix", "Automatically fix problems").option("--config-stylelint <path>", "Path to stylelint config file").option("--config-eslint <path>", "Path to eslint config file").option("--editor <editor>", "Editor to open files with (e.g., vscode, atom, sublime). Auto-detects if not specified").action(async (directory, options) => {
     const startTime = Date.now();
     try {
       Logger.info(chalk.blue("Starting lint process..."));

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.2.2");
+  program.description("SLDS Linter CLI tool for linting styles and components").version("0.3.1-internal-beta.0");
 }
 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.2.2";
+var LINTER_CLI_VERSION = "0.3.1-internal-beta.0";
 var getRuleDescription = (ruleId) => {
   const ruleIdWithoutNameSpace = `${ruleId}`.replace(/\@salesforce-ux\//, "");
   return ruleMetadata(ruleIdWithoutNameSpace)?.ruleDesc || "--";

package/build/utils/config-utils.js

@@ -4,6 +4,7 @@ import { DEFAULT_ESLINT_CONFIG_PATH, DEFAULT_STYLELINT_CONFIG_PATH } from "../se
 import { isDynamicPattern } from "globby";
 import { accessSync } from "fs";
 import { Logger } from "./logger.js";
+import { detectCurrentEditor } from "./editorLinkUtil.js";
 function normalizeAndValidatePath(inputPath) {
   if (!inputPath) {
     Logger.debug("No path provided, using current working directory");
@@ -41,7 +42,7 @@ function normalizeCliOptions(options, defaultOptions = {}, isNodeApi = false) {
   if (!isNodeApi) {
     Object.assign(baseDefaults, {
       fix: false,
-      editor: "vscode",
+      editor: detectCurrentEditor(),
       format: "sarif"
     });
   }

package/build/utils/editorLinkUtil.d.ts

@@ -1,7 +1,13 @@
+/**
+ * Auto-detects the current editor based on environment variables and common patterns.
+ *
+ * @returns The detected editor name or 'vscode' as fallback
+ */
+export declare function detectCurrentEditor(): string;
 /**
  * Returns an editor-specific link for opening a file at a given line and column.
  *
- * @param editor - The editor to use (e.g., 'vscode', 'atom', 'sublime').
+ * @param editor - The editor to use (e.g., 'vscode').
  * @param absolutePath - The absolute path to the file.
  * @param line - The line number in the file.
  * @param column - The column number in the file.
@@ -15,7 +21,7 @@ export declare function getEditorLink(editor: string, absolutePath: string, line
  * @param absolutePath - The absolute path to the file.
  * @param line - The line number in the file.
  * @param column - The column number in the file.
- * @param editor - The editor to use (e.g., 'vscode', 'atom', 'sublime').
+ * @param editor - The editor to use (e.g., 'vscode', 'atom', 'sublime'). If not provided, will auto-detect.
  * @returns A string with ANSI escape sequences to create a clickable hyperlink.
  */
-export declare function createClickableLineCol(lineCol: string, absolutePath: string, line: number, column: number, editor: string): string;
+export declare function createClickableLineCol(lineCol: string, absolutePath: string, line: number, column: number, editor?: string): string;

package/build/utils/editorLinkUtil.js

@@ -1,21 +1,52 @@
 // src/utils/editorLinkUtil.ts
 import chalk from "chalk";
+function detectCurrentEditor() {
+  const editor = process.env.EDITOR || process.env.VISUAL;
+  if (editor) {
+    const editorName = editor.toLowerCase();
+    if (editorName.includes("code") || editorName.includes("vscode")) {
+      return "vscode";
+    } else if (editorName.includes("cursor")) {
+      return "cursor";
+    } else if (editorName.includes("atom")) {
+      return "atom";
+    } else if (editorName.includes("sublime") || editorName.includes("subl")) {
+      return "sublime";
+    } else if (editorName.includes("vim") || editorName.includes("nvim")) {
+      return "vim";
+    } else if (editorName.includes("emacs")) {
+      return "emacs";
+    } else if (editorName.includes("nano")) {
+      return "nano";
+    }
+  }
+  if (process.env.CURSOR_TRACE_ID || (process.env.TERM_PROGRAM || "").toLowerCase().includes("cursor")) {
+    return "cursor";
+  }
+  if (process.env.VSCODE_PID || (process.env.TERM_PROGRAM || "").toLowerCase().includes("vscode")) {
+    return "vscode";
+  }
+  return "vscode";
+}
 function getEditorLink(editor, absolutePath, line, column) {
-  if (editor === "vscode") {
-    return `vscode://file/${absolutePath}:${line}:${column}`;
-  } else if (editor === "atom") {
-    return `atom://core/open/file?filename=${absolutePath}&line=${line}&column=${column}`;
-  } else if (editor === "sublime") {
-    return `file://${absolutePath}:${line}:${column}`;
-  } else {
-    return `file://${absolutePath}:${line}:${column}`;
+  switch (editor.toLowerCase()) {
+    case "vscode":
+      return `vscode://file/${absolutePath}:${line}:${column}`;
+    case "cursor":
+      return `cursor://file/${absolutePath}:${line}:${column}`;
+    case "atom":
+      return `atom://core/open/file?filename=${absolutePath}&line=${line}&column=${column}`;
+    default:
+      return `file://${absolutePath}:${line}:${column}`;
   }
 }
 function createClickableLineCol(lineCol, absolutePath, line, column, editor) {
-  const link = getEditorLink(editor, absolutePath, line, column);
+  const detectedEditor = editor || detectCurrentEditor();
+  const link = getEditorLink(detectedEditor, absolutePath, line, column);
   return `\x1B]8;;${link}\x07${chalk.blueBright(lineCol)}\x1B]8;;\x07`;
 }
 export {
   createClickableLineCol,
+  detectCurrentEditor,
   getEditorLink
 };

package/build/utils/lintResultsUtil.d.ts

@@ -15,7 +15,7 @@ export declare function parseText(text: string): string;
  * Prints detailed lint results for each file that has issues.
  *
  * @param results - Array of lint results.
- * @param editor - The chosen editor for clickable links (e.g., "vscode", "atom", "sublime").
+ * @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): void;
+export declare function printLintResults(results: LintResult[], editor?: string): void;
 export declare function transformedResults(lintResult: LintResult, entry: LintResultEntry, level: 'error' | 'warning'): SarifResultEntry;

package/build/workers/stylelint.worker.js

@@ -21,7 +21,7 @@ var StylelintWorker = class extends BaseWorker {
           endColumn: warning.endColumn,
           message: warning.text,
           ruleId: warning.rule
-        })),
+        })).sort((a, b) => a.line - b.line),
         errors: []
         // Stylelint doesn't differentiate between warnings and errors
       };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "0.2.2",
+  "version": "0.3.1-internal-beta.0",
   "description": "SLDS Linter CLI tool for linting styles and components",
   "keywords": [
     "lightning design system linter",
@@ -29,13 +29,13 @@
   ],
   "bin": "build/index.js",
   "dependencies": {
-    "@salesforce-ux/eslint-plugin-slds": "0.2.2",
-    "@salesforce-ux/stylelint-plugin-slds": "0.2.2",
+    "@salesforce-ux/eslint-plugin-slds": "0.3.1-internal-beta.0",
+    "@salesforce-ux/stylelint-plugin-slds": "0.3.1-internal-beta.0",
     "@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",
+    "eslint": "8.57.1",
     "export-to-csv": "^1.4.0",
     "globby": "^14.1.0",
     "import-meta-resolve": "^4.1.0",
@@ -43,7 +43,7 @@
     "node-sarif-builder": "^3.2.0",
     "ora": "^5.4.1",
     "semver": "^7.7.1",
-    "stylelint": "^16.10.0"
+    "stylelint": "16.14.1"
   },
   "license": "ISC",
   "repository": {

package/build/executor/__tests__/executor.test.js

@@ -1,216 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __esm = (fn, res) => function __init() {
-  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/executor/index.ts
-var executor_exports = {};
-__export(executor_exports, {
-  lint: () => lint,
-  report: () => report
-});
-import { Readable } from "stream";
-import { FileScanner } from "../services/file-scanner.js";
-import { LintRunner } from "../services/lint-runner.js";
-import { StyleFilePatterns, ComponentFilePatterns } from "../services/file-patterns.js";
-import { ReportGenerator, CsvReportGenerator } from "../services/report-generator.js";
-import { LINTER_CLI_VERSION } from "../services/config.resolver.js";
-import { normalizeCliOptions } from "../utils/config-utils.js";
-import { Logger } from "../utils/logger.js";
-async function lint(config) {
-  try {
-    Logger.debug("Starting linting with Node API");
-    const normalizedConfig = normalizeCliOptions(config, {}, true);
-    const styleFiles = await FileScanner.scanFiles(normalizedConfig.directory, {
-      patterns: StyleFilePatterns,
-      batchSize: 100
-    });
-    const componentFiles = await FileScanner.scanFiles(normalizedConfig.directory, {
-      patterns: ComponentFilePatterns,
-      batchSize: 100
-    });
-    const lintOptions = {
-      fix: normalizedConfig.fix,
-      configPath: normalizedConfig.configStylelint
-    };
-    const styleResults = await LintRunner.runLinting(styleFiles, "style", {
-      ...lintOptions,
-      configPath: normalizedConfig.configStylelint
-    });
-    const componentResults = await LintRunner.runLinting(componentFiles, "component", {
-      ...lintOptions,
-      configPath: normalizedConfig.configEslint
-    });
-    const combinedResults = [...styleResults, ...componentResults];
-    return standardizeLintMessages(combinedResults);
-  } catch (error) {
-    const errorMessage = `Linting failed: ${error.message}`;
-    Logger.error(errorMessage);
-    throw new Error(errorMessage);
-  }
-}
-async function report(config, results) {
-  try {
-    Logger.debug("Starting report generation with Node API");
-    const normalizedConfig = normalizeCliOptions(config, {}, true);
-    const format = normalizedConfig.format || "sarif";
-    const lintResults = results || await lint({
-      directory: normalizedConfig.directory,
-      configStylelint: normalizedConfig.configStylelint,
-      configEslint: normalizedConfig.configEslint
-    });
-    switch (format) {
-      case "sarif":
-        return ReportGenerator.generateSarifReportStream(lintResults, {
-          toolName: "slds-linter",
-          toolVersion: LINTER_CLI_VERSION
-        });
-      case "csv":
-        const csvString = CsvReportGenerator.generateCsvString(lintResults);
-        const csvStream = new Readable();
-        csvStream.push(csvString);
-        csvStream.push(null);
-        return csvStream;
-      default:
-        const errorMessage = `Unsupported format: ${format}`;
-        Logger.error(errorMessage);
-        throw new Error(errorMessage);
-    }
-  } catch (error) {
-    const errorMessage = `Report generation failed: ${error.message}`;
-    Logger.error(errorMessage);
-    throw new Error(errorMessage);
-  }
-}
-function standardizeLintMessages(results) {
-  return results.map((result) => ({
-    ...result,
-    errors: result.errors.map((entry) => {
-      let msgObj;
-      try {
-        msgObj = JSON.parse(entry.message);
-        if (typeof msgObj === "object" && "message" in msgObj) {
-          return { ...entry, ...msgObj };
-        }
-      } catch {
-      }
-      return { ...entry, message: entry.message };
-    }),
-    warnings: result.warnings.map((entry) => {
-      let msgObj;
-      try {
-        msgObj = JSON.parse(entry.message);
-        if (typeof msgObj === "object" && "message" in msgObj) {
-          return { ...entry, ...msgObj };
-        }
-      } catch {
-      }
-      return { ...entry, message: entry.message };
-    })
-  }));
-}
-var init_executor = __esm({
-  "src/executor/index.ts"() {
-  }
-});
-
-// src/executor/__tests__/executor.test.ts
-import { lint as lint2, report as report2 } from "../index.js";
-import { LintRunner as LintRunner2 } from "../../services/lint-runner.js";
-import { FileScanner as FileScanner2 } from "../../services/file-scanner.js";
-import { Readable as Readable2 } from "stream";
-import { jest } from "@jest/globals.js";
-var mockLintResult = {
-  filePath: "file1.css",
-  errors: [{ line: 1, column: 1, endColumn: 10, message: "Test error", ruleId: "test-rule", severity: 2 }],
-  warnings: []
-};
-jest.mock("../../services/lint-runner", () => {
-  return {
-    LintRunner: {
-      runLinting: jest.fn().mockImplementation(() => {
-        return Promise.resolve([mockLintResult]);
-      })
-    }
-  };
-});
-jest.mock("../../services/file-scanner", () => {
-  return {
-    FileScanner: {
-      scanFiles: jest.fn().mockImplementation(() => {
-        return Promise.resolve([["file1.css"]]);
-      })
-    }
-  };
-});
-jest.mock("fs/promises");
-xdescribe("Executor functions", () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-  describe("lint", () => {
-    it("should scan directory and run linting when no files are provided", async () => {
-      const config = {
-        directory: "./src",
-        fix: true
-      };
-      const results = await lint2(config);
-      expect(FileScanner2.scanFiles).toHaveBeenCalledTimes(2);
-      expect(LintRunner2.runLinting).toHaveBeenCalledTimes(2);
-      expect(results).toHaveLength(2);
-    });
-    it("should use provided files and skip scanning when files are provided", async () => {
-      const config = {
-        files: ["file1.css", "component1.html"]
-      };
-      await lint2(config);
-      expect(FileScanner2.scanFiles).not.toHaveBeenCalled();
-      expect(LintRunner2.runLinting).toHaveBeenCalledTimes(2);
-    });
-  });
-  describe("report", () => {
-    it("should return a readable stream", async () => {
-      const config = {
-        directory: "./src",
-        format: "sarif"
-      };
-      const stream = await report2(config);
-      expect(stream).toBeInstanceOf(Readable2);
-    });
-    it("should use lint results to generate a report", async () => {
-      const lintMock = jest.spyOn((init_executor(), __toCommonJS(executor_exports)), "lint").mockResolvedValue([mockLintResult]);
-      const config = {
-        directory: "./src",
-        format: "sarif"
-      };
-      await report2(config);
-      expect(lintMock).toHaveBeenCalledWith({
-        directory: "./src",
-        configStylelint: expect.any(String),
-        configEslint: expect.any(String)
-      });
-      lintMock.mockRestore();
-    });
-  });
-});
-describe("Executor placeholder tests", () => {
-  it("should be implemented in the future", () => {
-    expect(true).toBe(true);
-  });
-});

package/build/services/__tests__/file-scanner.test.js

@@ -1,47 +0,0 @@
-// src/services/__tests__/file-scanner.test.ts
-import path from "path";
-import { FileScanner } from "../file-scanner.js";
-import { StyleFilePatterns } from "../file-patterns.js";
-import { mkdir, writeFile, rm } from "fs/promises";
-import { fileURLToPath } from "url";
-var __filename = fileURLToPath(import.meta.url);
-var __dirname = path.dirname(__filename);
-describe("FileScanner", () => {
-  const testDir = path.join(__dirname, "fixtures");
-  beforeAll(async () => {
-    await mkdir(testDir, { recursive: true });
-    await writeFile(
-      path.join(testDir, "test.css"),
-      "body { color: red; }"
-    );
-    await writeFile(
-      path.join(testDir, "test.scss"),
-      "$color: red;"
-    );
-  });
-  afterAll(async () => {
-    await rm(testDir, { recursive: true });
-  });
-  it("should scan and batch files correctly", async () => {
-    const options = {
-      patterns: StyleFilePatterns,
-      batchSize: 1
-    };
-    const batches = await FileScanner.scanFiles(testDir, options);
-    expect(batches).toHaveLength(2);
-    expect(batches[0]).toHaveLength(1);
-    expect(batches[1]).toHaveLength(1);
-    expect(batches[0][0]).toMatch(/test\.(css|scss)$/);
-    expect(batches[1][0]).toMatch(/test\.(css|scss)$/);
-  });
-  it("should handle invalid files gracefully", async () => {
-    const options = {
-      patterns: {
-        extensions: ["nonexistent"],
-        exclude: []
-      }
-    };
-    const batches = await FileScanner.scanFiles(testDir, options);
-    expect(batches).toHaveLength(0);
-  });
-});