@salesforce-ux/slds-linter 1.0.8-internal → 1.0.10-internal

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

package/build/services/batch-processor.js

@@ -2,6 +2,7 @@
 import { Worker } from "worker_threads";
 import os from "os";
 import { Logger } from "../utils/logger.js";
+import { ProgressHandler } from "./progress-handler.js";
 var AVAILABLE_CPUS = os.cpus().length - 1;
 var BatchProcessor = class {
   static DEFAULT_MAX_WORKERS = Math.max(1, Math.min(4, AVAILABLE_CPUS));
@@ -22,6 +23,7 @@ var BatchProcessor = class {
     const results = [];
     const activeWorkers = /* @__PURE__ */ new Set();
     let currentBatchIndex = 0;
+    const progress = new ProgressHandler({ total: batches.length });
     try {
       while (currentBatchIndex < batches.length || activeWorkers.size > 0) {
         while (activeWorkers.size < maxWorkers && currentBatchIndex < batches.length) {
@@ -36,6 +38,7 @@ var BatchProcessor = class {
           worker.on("message", (result) => {
             results.push(result);
             activeWorkers.delete(worker);
+            progress.increment();
             Logger.debug(`Completed batch ${batchIndex} of ${batches.length}`);
           }).on("error", (error) => {
             results.push({
@@ -44,6 +47,7 @@ var BatchProcessor = class {
               results: []
             });
             activeWorkers.delete(worker);
+            progress.increment();
             Logger.error(`Worker error in batch ${batchIndex}: ${error.message}`);
           }).on("exit", (code) => {
             if (code !== 0) {
@@ -54,8 +58,10 @@ var BatchProcessor = class {
         }
         await new Promise((resolve) => setTimeout(resolve, 100));
       }
+      progress.stop();
       return results;
     } catch (error) {
+      progress.stop();
       Logger.error(`Batch processing failed: ${error.message}`);
       throw error;
     } finally {

package/build/services/config.resolver.js

@@ -1,166 +1,12 @@
 // src/services/config.resolver.ts
 import { resolvePath } from "../utils/nodeVersionUtil.js";
-
-// yaml-file:/Users/ritesh.kumar2/Documents/projects/stylelint-sds/packages/eslint-plugin-slds/src/config/rule-messages.yml
-var rule_messages_default = {
-  "no-slds-class-overrides": {
-    "description": "Create new custom CSS classes instead of overriding SLDS selectors",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-class-overrides",
-    "type": "problem",
-    "messages": {
-      "sldsClassOverride": "Overriding .{{className}} isn't supported. To differentiate SLDS and custom classes, create a CSS class in your namespace. Examples: myapp-input, myapp-button."
-    }
-  },
-  "no-deprecated-slds-classes": {
-    "description": "Please replace the deprecated classes with a modern equivalent",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-slds-classes",
-    "type": "problem",
-    "messages": {
-      "deprecatedClass": "The class {{className}} is deprecated and not available in SLDS2. Please update to a supported class."
-    }
-  },
-  "no-deprecated-tokens-slds1": {
-    "description": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-tokens-slds1",
-    "type": "problem",
-    "messages": {
-      "deprecatedToken": "Consider removing {{oldValue}} or replacing it with {{newValue}}. Set the fallback to {{oldValue}}. For more info, see Styling Hooks on lightningdesignsystem.com.",
-      "noReplacement": "Update outdated design tokens to SLDS 2 styling hooks with similar values. For more information, see Styling Hooks on lightningdesignsystem.com."
-    }
-  },
-  "enforce-sds-to-slds-hooks": {
-    "description": "Convert your existing --sds styling hooks to --slds styling hooks. See lightningdesignsystem.com for more info.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-sds-to-slds-hooks",
-    "type": "problem",
-    "messages": {
-      "replaceSdsWithSlds": "Replace {{oldValue}} with {{suggestedMatch}} styling hook."
-    }
-  },
-  "enforce-bem-usage": {
-    "description": "Replace BEM double-dash syntax in class names with single underscore syntax",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-bem-usage",
-    "type": "problem",
-    "messages": {
-      "bemDoubleDash": "{{actual}} has been retired. Update it to the new name {{newValue}}.",
-      "fixBemNaming": "Update to correct BEM naming convention"
-    }
-  },
-  "modal-close-button-issue": {
-    "description": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#modal-close-button-issue",
-    "type": "problem",
-    "messages": {
-      "modalCloseButtonIssue": "Update component attributes or CSS classes for the modal close button to comply with the modal component blueprint.",
-      "removeClass": "Remove the slds-button_icon-inverse class from the modal close button in components that use the SLDS modal blueprint.",
-      "changeVariant": "Change the variant attribute value from bare-inverse to bare in <lightning-button-icon> or <lightning-icon>.",
-      "removeVariant": "Remove the variant attribute from the <lightning-icon> component inside the <button> element.",
-      "ensureButtonClasses": "Add or move slds-button and slds-button_icon to the class attribute of the <button> element or <lightning-button-icon> component.",
-      "ensureSizeAttribute": "To size icons properly, set the size attribute \u200Cto large in the <lightning-icon> and <lightning-button-icon> components."
-    }
-  },
-  "no-deprecated-classes-slds2": {
-    "description": "Replace classes that aren't available with SLDS 2 classes",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-deprecated-classes-slds2",
-    "type": "problem",
-    "messages": {
-      "deprecatedClass": "The class {{className}} isn't available in SLDS 2. Update it to a class supported in SLDS 2. See lightningdesignsystem.com for more information.",
-      "updateToModernClass": "Replace deprecated class with modern equivalent",
-      "checkDocumentation": "See lightningdesignsystem.com for SLDS 2 class alternatives"
-    }
-  },
-  "lwc-token-to-slds-hook": {
-    "description": "Replace the deprecated --lwc tokens with the latest --slds tokens. See lightningdesignsystem.com for more info.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#lwc-token-to-slds-hook",
-    "type": "problem",
-    "messages": {
-      "errorWithReplacement": "The '{{oldValue}}' design token is deprecated. Replace it with '{{newValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
-      "errorWithStyleHooks": "The '{{oldValue}}' design token is deprecated. Replace it with the SLDS 2 '{{newValue}}' styling hook and set the fallback to '{{oldValue}}'. For more info, see Global Styling Hooks on lightningdesignsystem.com.",
-      "errorWithNoRecommendation": "The '{{oldValue}}' design token is deprecated. For more info, see the New Global Styling Hook Guidance on lightningdesignsystem.com."
-    }
-  },
-  "no-sldshook-fallback-for-lwctoken": {
-    "description": "Avoid using --slds styling hooks as fallback values for --lwc tokens.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-sldshook-fallback-for-lwctoken",
-    "type": "problem",
-    "messages": {
-      "unsupportedFallback": "Remove the {{sldsToken}} styling hook that is used as a fallback value for {{lwcToken}}."
-    }
-  },
-  "no-unsupported-hooks-slds2": {
-    "description": "Identifies styling hooks that aren't present in SLDS 2. They must be replaced with styling hooks that have a similar effect, or they must be removed.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-unsupported-hooks-slds2",
-    "type": "problem",
-    "messages": {
-      "deprecated": "The {{token}} styling hook isn't present in SLDS 2 and there's no equivalent replacement. Remove it or replace it with a styling hook with a similar effect."
-    }
-  },
-  "no-slds-var-without-fallback": {
-    "description": "Add fallback values to SLDS styling hooks. The fallback values are used in Salesforce environments where styling hooks are unavailable.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-var-without-fallback",
-    "type": "problem",
-    "messages": {
-      "varWithoutFallback": "Your code uses the {{cssVar}} styling hook without a fallback value. Styling hooks are unavailable in some Salesforce environments. To render your component correctly in all environments, add this fallback value: var({{cssVar}}, {{recommendation}}). To make this fallback value brand-aware, use a branded design token instead of a static value. See Design Tokens on v1.lightningdesignsystem.com."
-    }
-  },
-  "no-slds-namespace-for-custom-hooks": {
-    "description": "To differentiate custom styling hooks from SLDS styling hooks, create custom styling hooks in your namespace.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-namespace-for-custom-hooks",
-    "type": "problem",
-    "messages": {
-      "customHookNamespace": "Using the --slds namespace for {{token}} isn't supported. Create the custom styling hook in your namespace. Example: --myapp-{{tokenWithoutNamespace}}"
-    }
-  },
-  "no-slds-private-var": {
-    "description": "Some SLDS styling hooks are private and reserved only for internal Salesforce use. Private SLDS styling hooks have prefixes --_slds- and --slds-s-. For more information, look up private CSS in lightningdesignsystem.com.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-slds-private-var",
-    "type": "problem",
-    "messages": {
-      "privateVar": "This styling hook is reserved for internal Salesforce use. Remove the --_slds- or \u2013slds-s private variable within selector {{prop}}. For more information, look up private CSS in lightningdesignsystem.com."
-    }
-  },
-  "enforce-component-hook-naming-convention": {
-    "description": "Replace component styling hooks that use a deprecated naming convention.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#enforce-component-hook-naming-convention",
-    "type": "problem",
-    "messages": {
-      "replace": "Replace the deprecated {{oldValue}} component styling hook with {{suggestedMatch}}."
-    }
-  },
-  "no-hardcoded-values-slds1": {
-    "description": "Replace static values with SLDS 1 design tokens. For more information, look up design tokens on lightningdesignsystem.com.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-value",
-    "type": "suggestion",
-    "messages": {
-      "hardcodedValue": "Replace the {{oldValue}} static value with an SLDS 1 styling hook: {{newValue}}.",
-      "noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
-    }
-  },
-  "no-hardcoded-values-slds2": {
-    "description": "Replace static values with SLDS 2 styling hooks. For more information, look up design tokens on lightningdesignsystem.com.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#no-hardcoded-values-slds2",
-    "type": "suggestion",
-    "messages": {
-      "hardcodedValue": "Consider replacing the {{oldValue}} static value with an SLDS 2 styling hook that has a similar value: {{newValue}}.",
-      "noReplacement": "There's no replacement styling hook for the {{oldValue}} static value. Remove the static value."
-    }
-  },
-  "reduce-annotations": {
-    "description": "Remove your annotations and update your code.",
-    "url": "https://developer.salesforce.com/docs/platform/slds-linter/guide/reference-rules.html#reduce-annotations",
-    "type": "problem",
-    "messages": {
-      "removeAnnotation": "Remove this annotation and update the code to SLDS best practices. For help, file an issue at https://github.com/salesforce-ux/slds-linter/"
-    }
-  }
-};
-
-// src/services/config.resolver.ts
+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.0.8-internal";
+var LINTER_CLI_VERSION = "1.0.10-internal";
 var getRuleDescription = (ruleId) => {
   const ruleIdWithoutNameSpace = `${ruleId}`.replace(/\@salesforce-ux\//, "").replace(/^slds\//, "");
-  return rule_messages_default[ruleIdWithoutNameSpace]?.description || "--";
+  return ruleMessages[ruleIdWithoutNameSpace]?.description || "--";
 };
 export {
   DEFAULT_ESLINT_CONFIG_PATH,

package/build/services/progress-handler.d.ts

@@ -0,0 +1,25 @@
+export interface ProgressHandlerOptions {
+    total: number;
+    format?: string;
+}
+export declare class ProgressHandler {
+    private progressBar;
+    private completed;
+    constructor(options: ProgressHandlerOptions);
+    /**
+     * Increment progress by one unit
+     */
+    increment(): void;
+    /**
+     * Update progress to a specific value
+     */
+    update(value: number): void;
+    /**
+     * Stop and cleanup the progress bar
+     */
+    stop(): void;
+    /**
+     * Get current progress value
+     */
+    getCompleted(): number;
+}

package/build/services/progress-handler.js

@@ -0,0 +1,56 @@
+// src/services/progress-handler.ts
+import cliProgress from "cli-progress";
+import chalk from "chalk";
+var ProgressHandler = class {
+  progressBar = null;
+  completed = 0;
+  constructor(options) {
+    const format = options.format || `Processing [{bar}] {percentage}% ({value}/{total})`;
+    const isCI = String(process.env.CI || "").toLowerCase() === "true" || process.env.CI === "1";
+    const isTTY = Boolean(process.stdout.isTTY);
+    if (!isTTY || isCI) {
+      return;
+    }
+    this.progressBar = new cliProgress.SingleBar({
+      format,
+      barCompleteChar: "\u2588",
+      barIncompleteChar: "\u2591",
+      hideCursor: true,
+      formatBar: (progress, options2) => {
+        const completeSize = Math.round(progress * options2.barsize);
+        const incompleteSize = options2.barsize - completeSize;
+        return chalk.cyan(options2.barCompleteChar.repeat(completeSize)) + chalk.cyanBright(options2.barIncompleteChar.repeat(incompleteSize));
+      }
+    });
+    this.progressBar.start(options.total, 0);
+  }
+  /**
+   * Increment progress by one unit
+   */
+  increment() {
+    this.completed++;
+    this.progressBar?.update(this.completed);
+  }
+  /**
+   * Update progress to a specific value
+   */
+  update(value) {
+    this.completed = value;
+    this.progressBar?.update(value);
+  }
+  /**
+   * Stop and cleanup the progress bar
+   */
+  stop() {
+    this.progressBar?.stop();
+  }
+  /**
+   * Get current progress value
+   */
+  getCompleted() {
+    return this.completed;
+  }
+};
+export {
+  ProgressHandler
+};

package/build/utils/lintResultsUtil.js

@@ -16,6 +16,34 @@ function parseText(text) {
   }
   return safeText.endsWith(".") ? safeText : `${safeText}.`;
 }
+function printTotalViolationsSummary(totalErrors, totalWarnings) {
+  const totalProblems = totalErrors + totalWarnings;
+  let totalProblemsText = `${totalProblems} SLDS Violation${totalProblems !== 1 ? "s" : ""}`;
+  if (totalErrors > 0) {
+    totalProblemsText = Colors.error(`\u2716 ${totalProblemsText}`);
+  } else {
+    totalProblemsText = Colors.warning(`\u26A0 ${totalProblemsText}`);
+  }
+  const totalBreakdown = [
+    Colors.error(`${totalErrors} error${totalErrors !== 1 ? "s" : ""}`),
+    Colors.warning(`${totalWarnings} warning${totalWarnings !== 1 ? "s" : ""}`)
+  ];
+  console.log(`${totalProblemsText} (${totalBreakdown.join(", ")})`);
+}
+function printFixableViolationsSummary(fixableErrors, fixableWarnings) {
+  const fixableTotal = fixableErrors + fixableWarnings;
+  if (!fixableTotal) {
+    return;
+  }
+  const fixableBreakdown = [];
+  if (fixableErrors > 0) {
+    fixableBreakdown.push(Colors.error(`${fixableErrors} error${fixableErrors !== 1 ? "s" : ""}`));
+  }
+  if (fixableWarnings > 0) {
+    fixableBreakdown.push(Colors.warning(`${fixableWarnings} warning${fixableWarnings !== 1 ? "s" : ""}`));
+  }
+  console.log(`  ${fixableBreakdown.join(" and ")} potentially fixable with the \`--fix\` option.`);
+}
 function printLintResults(results, editor) {
   let totalErrors = 0;
   let totalWarnings = 0;
@@ -53,19 +81,12 @@ ${Colors.info.underline(relativeFile)}
       });
     }
   });
-  const totalProblems = totalErrors + totalWarnings;
-  if (totalProblems > 0) {
-    const chalkColorFn = totalErrors > 0 ? Colors.errorBold : Colors.warningBold;
-    console.log("");
-    const problemsText = `\u2716 ${totalProblems} SLDS Violation${totalProblems !== 1 ? "s" : ""} (${totalErrors} error${totalErrors !== 1 ? "s" : ""}, ${totalWarnings} warning${totalWarnings !== 1 ? "s" : ""})`;
-    console.log(chalkColorFn(problemsText));
-    const fixableTotal = fixableErrors + fixableWarnings;
-    if (fixableTotal > 0) {
-      const fixableText = `  ${fixableErrors} error${fixableErrors !== 1 ? "s" : ""} and ${fixableWarnings} warning${fixableWarnings !== 1 ? "s" : ""} potentially fixable with the \`--fix\` option.`;
-      console.log(chalkColorFn(fixableText));
-    }
+  Logger.newLine();
+  if (totalErrors > 0 || totalWarnings > 0) {
+    printTotalViolationsSummary(totalErrors, totalWarnings);
+    printFixableViolationsSummary(fixableErrors, fixableWarnings);
   } else {
-    Logger.newLine().success("No SLDS Violations found.");
+    Logger.success("No SLDS Violations found.");
   }
   return { totalErrors, totalWarnings, fixableErrors, fixableWarnings };
 }

package/build/workers/eslint.worker.d.ts

@@ -1 +1,7 @@
-export {};
+import { BaseWorker } from './base.worker';
+import { WorkerConfig, WorkerResult } from '../types';
+export declare class ESLintWorker extends BaseWorker<WorkerConfig, WorkerResult> {
+    private eslint;
+    constructor();
+    protected processFile(filePath: string): Promise<WorkerResult>;
+}

package/build/workers/eslint.worker.js

@@ -1,5 +1,6 @@
 // src/workers/eslint.worker.ts
 import { ESLint } from "eslint";
+import { isMainThread } from "worker_threads";
 import { BaseWorker } from "./base.worker.js";
 var ESLintWorker = class extends BaseWorker {
   eslint;
@@ -29,8 +30,13 @@ var ESLintWorker = class extends BaseWorker {
     }
   }
 };
-var worker = new ESLintWorker();
-worker.process().catch((error) => {
-  console.error("Worker failed:", error);
-  process.exit(1);
-});
+if (!isMainThread) {
+  const worker = new ESLintWorker();
+  worker.process().catch((error) => {
+    console.error("Worker failed:", error);
+    process.exit(1);
+  });
+}
+export {
+  ESLintWorker
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "1.0.8-internal",
+  "version": "1.0.10-internal",
   "description": "SLDS Linter CLI tool for linting styles and components",
   "keywords": [
     "lightning design system linter",
@@ -29,10 +29,11 @@
   ],
   "bin": "build/index.js",
   "dependencies": {
-    "@salesforce-ux/eslint-plugin-slds": "1.0.8-internal",
+    "@salesforce-ux/eslint-plugin-slds": "1.0.10-internal",
     "@typescript-eslint/eslint-plugin": "^8.36.0",
     "@typescript-eslint/parser": "^8.36.0",
     "chalk": "^4.1.2",
+    "cli-progress": "^3.12.0",
     "commander": "^13.1.0",
     "eslint": "^9.0.0",
     "export-to-csv": "^1.4.0",