@salesforce-ux/slds-linter 1.0.1 → 1.0.2-alpha.0

package/build/commands/emit.js

@@ -6,7 +6,41 @@ import {
   DEFAULT_ESLINT_CONFIG_PATH
 } from "../services/config.resolver.js";
 import path from "path";
-import { copyFile } from "fs/promises";
+import { writeFile, readFile } from "fs/promises";
+import sldsPlugin from "@salesforce-ux/eslint-plugin-slds";
+function extractRulesFromConfig(configToExtract) {
+  configToExtract = Array.isArray(configToExtract) ? configToExtract : [configToExtract];
+  const allRules = {};
+  configToExtract.forEach((config) => {
+    if (config.rules) Object.assign(allRules, config.rules);
+  });
+  return Object.keys(allRules).length > 0 ? allRules : null;
+}
+async function loadRuleConfigs() {
+  try {
+    const plugin = sldsPlugin;
+    const configToExtract = plugin.configs?.["flat/recommended"] || plugin.configs?.["recommended"];
+    return extractRulesFromConfig(configToExtract);
+  } catch (error) {
+    return null;
+  }
+}
+function formatRulesForConfig(rules) {
+  return JSON.stringify(rules, null, 4).replace(/\n/g, "\n    ");
+}
+async function generateEnhancedESLintConfig(sourceConfigPath) {
+  const config = await readFile(sourceConfigPath, "utf8");
+  const rules = await loadRuleConfigs();
+  if (rules) {
+    const formattedRules = formatRulesForConfig(rules);
+    return config.replace(
+      /extends:\s*\["@salesforce-ux\/slds\/recommended"\]/,
+      `extends: ["@salesforce-ux/slds/recommended"],
+    rules: ${formattedRules}`
+    );
+  }
+  return config;
+}
 function registerEmitCommand(program) {
   program.command("emit").description("Emits the configuration files used by slds-linter cli").option(
     "-d, --directory <path>",
@@ -17,14 +51,13 @@ function registerEmitCommand(program) {
       const normalizedOptions = normalizeCliOptions(options, {
         configEslint: DEFAULT_ESLINT_CONFIG_PATH
       });
-      const destESLintConfigPath = path.join(
-        normalizedOptions.directory,
-        path.basename(normalizedOptions.configEslint)
-      );
-      await copyFile(normalizedOptions.configEslint, destESLintConfigPath);
+      const enhancedConfig = await generateEnhancedESLintConfig(normalizedOptions.configEslint);
+      const destESLintConfigPath = path.join(normalizedOptions.directory, path.basename(normalizedOptions.configEslint));
+      await writeFile(destESLintConfigPath, enhancedConfig, "utf8");
       Logger.success(chalk.green(`ESLint configuration created at:
 ${destESLintConfigPath}
 `));
+      Logger.info(chalk.cyan("Rules are dynamically loaded based on extends configuration."));
     } catch (error) {
       Logger.error(
         chalk.red(`Failed to emit configuration: ${error.message}`)

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

package/build/services/config-loader.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Config Loader Service
+ * Sets up NODE_PATH to make CLI's bundled dependencies available to user configs
+ * This allows users to import @salesforce-ux/eslint-plugin-slds without installing it
+ */
+export declare class ConfigLoader {
+    private static nodePath;
+    /**
+     * Initialize module resolution to include CLI's bundled dependencies
+     * This allows user configs to import the plugin directly from CLI's node_modules
+     */
+    static setupBundledDependencies(): void;
+    /**
+     * Get the path to CLI's node_modules (for reference)
+     */
+    static getBundledModulesPath(): string | null;
+}

package/build/services/config-loader.js

@@ -0,0 +1,42 @@
+// src/services/config-loader.ts
+import { createRequire } from "module";
+import { dirname } from "path";
+import { Logger } from "../utils/logger.js";
+var ConfigLoader = class {
+  static nodePath = null;
+  /**
+   * Initialize module resolution to include CLI's bundled dependencies
+   * This allows user configs to import the plugin directly from CLI's node_modules
+   */
+  static setupBundledDependencies() {
+    if (this.nodePath) {
+      return;
+    }
+    try {
+      const require2 = createRequire(import.meta.url);
+      const pluginMainPath = require2.resolve("@salesforce-ux/eslint-plugin-slds");
+      const pluginDir = dirname(pluginMainPath);
+      const pluginRoot = dirname(pluginDir);
+      const scopeDir = dirname(pluginRoot);
+      const cliNodeModules = dirname(scopeDir);
+      const existingPath = process.env.NODE_PATH || "";
+      process.env.NODE_PATH = existingPath ? `${existingPath}:${cliNodeModules}` : cliNodeModules;
+      require2("module").Module._initPaths();
+      this.nodePath = cliNodeModules;
+      Logger.debug(`Using bundled dependencies from: ${cliNodeModules}`);
+      Logger.debug("User configs can now import @salesforce-ux/eslint-plugin-slds");
+    } catch (error) {
+      Logger.error(`Failed to setup bundled dependencies: ${error.message}`);
+      throw new Error(`Could not initialize bundled dependencies: ${error.message}`);
+    }
+  }
+  /**
+   * Get the path to CLI's node_modules (for reference)
+   */
+  static getBundledModulesPath() {
+    return this.nodePath;
+  }
+};
+export {
+  ConfigLoader
+};

package/build/services/config.resolver.js

@@ -137,7 +137,7 @@ var rule_messages_default = {
   },
   "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-value",
+    "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}}.",
@@ -156,8 +156,8 @@ var rule_messages_default = {
 
 // src/services/config.resolver.ts
 var DEFAULT_ESLINT_CONFIG_PATH = resolvePath("@salesforce-ux/eslint-plugin-slds/config", import.meta);
-var ESLINT_VERSION = "9.35.0";
-var LINTER_CLI_VERSION = "1.0.1";
+var ESLINT_VERSION = "9.36.0";
+var LINTER_CLI_VERSION = "1.0.2-alpha.0";
 var getRuleDescription = (ruleId) => {
   const ruleIdWithoutNameSpace = `${ruleId}`.replace(/\@salesforce-ux\//, "").replace(/^slds\//, "");
   return rule_messages_default[ruleIdWithoutNameSpace]?.description || "--";

package/build/services/lint-runner.js

@@ -3,6 +3,7 @@ import path from "path";
 import { BatchProcessor } from "./batch-processor.js";
 import { Logger } from "../utils/logger.js";
 import { resolveDirName } from "../utils/nodeVersionUtil.js";
+import { ConfigLoader } from "./config-loader.js";
 var LintRunner = class {
   /**
    * Run linting on batches of files
@@ -14,6 +15,7 @@ var LintRunner = class {
         "../workers",
         "eslint.worker.js"
       );
+      ConfigLoader.setupBundledDependencies();
       const workerConfig = {
         configPath: options.configPath,
         fix: options.fix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "1.0.1",
+  "version": "1.0.2-alpha.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.0.1",
+    "@salesforce-ux/eslint-plugin-slds": "1.0.2-alpha.0",
     "@typescript-eslint/eslint-plugin": "^8.36.0",
     "@typescript-eslint/parser": "^8.36.0",
     "chalk": "^4.1.2",