@codacy/tools-stylelint-0 0.24.0 → 0.25.0

package/README.md

@@ -1,6 +1,7 @@
 # @codacy/tools-stylelint-0
 
 ## Table of Contents
+
 - [Overview](#overview)
 - [Updating patterns](#updating-patterns)
 - [Updating the Stylelint version](#updating-the-stylelint-version)
@@ -13,14 +14,14 @@
 
 CSS/SCSS/Less linter using [Stylelint](https://stylelint.io). Uses the Library execution strategy — calls the Stylelint API directly rather than spawning a subprocess.
 
-| Property | Value |
-|----------|-------|
-| Tool ID | `Stylelint` |
-| Codacy UUID | `1f03328a-086e-459e-bfa3-73e56f01020f` |
-| Strategy | Library |
-| Languages | CSS, LESS, SASS |
-| Dependency | `stylelint` npm package (v16.x) |
-| File patterns | `**/*.css`, `**/*.scss`, `**/*.less` |
+| Property      | Value                                  |
+| ------------- | -------------------------------------- |
+| Tool ID       | `Stylelint`                            |
+| Codacy UUID   | `1f03328a-086e-459e-bfa3-73e56f01020f` |
+| Strategy      | Library                                |
+| Languages     | CSS, LESS, SASS                        |
+| Dependency    | `stylelint` npm package (v16.x)        |
+| File patterns | `**/*.css`, `**/*.scss`, `**/*.less`   |
 
 ## Updating patterns
 
@@ -36,11 +37,12 @@ Pattern IDs follow the format `Stylelint_block-no-empty`, `Stylelint_color-no-in
 
 ## Updating the Stylelint version
 
-1. Update the `stylelint` version in `package.json`
+1. Update the `stylelint` version in `devDependencies` of `package.json`, and `preferredVersion` in `src/metadata.ts`
 2. Run `pnpm install`
-3. Run `pnpm prefetch` to check for new/removed rules
-4. Run `pnpm test` to verify compatibility
-5. If the major version changes, create a new adapter package (`stylelint-1/`)
+3. Run `pnpm generate-payloads stylelint-0` from the repo root to re-pin `payload/package.json` and regenerate its lockfile
+4. Run `pnpm prefetch` to check for new/removed rules
+5. Run `pnpm test` to verify compatibility
+6. If the major version changes, create a new adapter package (`stylelint-1/`)
 
 ## Development
 
@@ -55,4 +57,4 @@ pnpm test     # Run tests
 - `stylelint-config-standard` is used as the default config when no local config or Codacy patterns are provided. Without it, Stylelint has zero rules enabled.
 - Stylelint appends the rule name in parentheses to warning text (e.g. `"Unexpected empty block (block-no-empty)"`). The adapter strips this suffix for cleaner messages.
 - `checkAvailability` dynamically imports Stylelint and runs a trivial lint to verify it loads.
-- `install` is a no-op — the npm dependency handles installation.
+- The tool is an npm _payload_, not a dependency: it is resolved at run time (a Codacy-managed install under `~/.codacy/tools/<id>/`, a `CODACY_TOOL_ROOT_<ID>` root, or this package's own `node_modules` in the monorepo) and `install` runs `npm ci` against the committed `payload/package-lock.json`. See `src/payload.ts`.

package/dist/index.js

@@ -33,11 +33,11 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_tooling2 = require("@codacy/tooling");
+var import_tooling3 = require("@codacy/tooling");
 
 // src/adapter.ts
-var import_tooling = require("@codacy/tooling");
-var import_path = __toESM(require("path"));
+var import_tooling2 = require("@codacy/tooling");
+var import_path2 = __toESM(require("path"));
 var import_fs = __toESM(require("fs"));
 
 // src/patterns.json
@@ -3487,7 +3487,21 @@ var descriptor = {
   frameworkMappings
 };
 
+// src/payload.ts
+var import_path = __toESM(require("path"));
+var PACKAGE_ROOT = import_path.default.resolve(__dirname, "..");
+var PAYLOAD = {
+  adapterId: descriptor.id,
+  displayName: descriptor.displayName,
+  version: descriptor.preferredVersion,
+  manifestDir: import_path.default.join(PACKAGE_ROOT, "payload"),
+  probe: "stylelint",
+  adjacentFrom: PACKAGE_ROOT,
+  isCompatible: (version) => version.startsWith("16.")
+};
+
 // src/plugin-registry.ts
+var import_tooling = require("@codacy/tooling");
 var A11Y_RULE_NAMES = /* @__PURE__ */ new Set([
   "content-property-no-static-value",
   "font-size-is-readable",
@@ -3536,7 +3550,7 @@ function findPluginForCodacyRule(codacyRuleId) {
 function findPluginForStylelintRule(stylelintRuleId) {
   return PLUGINS.find((p) => p.matchesStylelintRule(stylelintRuleId));
 }
-async function loadRequiredPlugins(codacyRuleIds) {
+async function loadRequiredPlugins(codacyRuleIds, payloadRoot) {
   const needed = /* @__PURE__ */ new Set();
   for (const id of codacyRuleIds) {
     const def = findPluginForCodacyRule(id);
@@ -3545,8 +3559,7 @@ async function loadRequiredPlugins(codacyRuleIds) {
   const perPackage = await Promise.all(
     Array.from(needed, async (def) => {
       try {
-        const mod = await import(def.packageName);
-        const exported = mod.default ?? mod;
+        const exported = await (0, import_tooling.importFromRoot)(payloadRoot, def.packageName);
         return Array.isArray(exported) ? exported : [exported];
       } catch {
         return [];
@@ -3583,7 +3596,7 @@ function ruleMetadata(ruleId) {
   const patternId = `${TOOL_ID}_${ruleId}`;
   return PATTERN_META.get(patternId) ?? { category: "CodeStyle", severity: "Info" };
 }
-async function buildStylelintConfig(patterns, logger) {
+async function buildStylelintConfig(patterns, payloadRoot, logger) {
   const rules = {};
   const prefix = `${TOOL_ID}_`;
   const codacyRuleIds = [];
@@ -3606,7 +3619,7 @@ async function buildStylelintConfig(patterns, logger) {
       rules[stylelintRuleId] = true;
     }
   }
-  const plugins = await loadRequiredPlugins(codacyRuleIds);
+  const plugins = await loadRequiredPlugins(codacyRuleIds, payloadRoot);
   const config = { rules };
   if (plugins.length > 0) {
     config.plugins = plugins;
@@ -3633,8 +3646,8 @@ function readLine(filePath, lineNumber) {
     return "";
   }
 }
-async function importStylelint() {
-  const mod = await import("stylelint");
+async function importStylelint(payloadRoot) {
+  const mod = await (0, import_tooling2.importFromRoot)(payloadRoot, "stylelint", { raw: true });
   return mod.lint ? mod : mod.default;
 }
 var adapter = {
@@ -3644,24 +3657,27 @@ var adapter = {
   website: "https://stylelint.io",
   prerequisites: [],
   /**
-   * Verifies that the `stylelint` npm package is loadable and returns its version.
-   * Because Stylelint is a direct runtime dependency, it should always be present.
+   * Resolves the Stylelint payload, verifies it is loadable with a trivial
+   * lint, and returns its version and where it was found — or, when it is not
+   * installed anywhere, the roots searched and how to install it.
    */
   async checkAvailability(ctx) {
     ctx.logger.debug("Checking availability", { toolId: TOOL_ID });
+    const payload = (0, import_tooling2.resolvePayload)(ctx, PAYLOAD);
+    if (!payload.found) {
+      ctx.logger.debug("Availability check result", {
+        toolId: TOOL_ID,
+        available: false,
+        reason: payload.reason
+      });
+      return (0, import_tooling2.payloadUnavailable)(payload, PAYLOAD);
+    }
     try {
-      const mod = await importStylelint();
+      const mod = await importStylelint(payload.root);
       await mod.lint({ code: "", config: { rules: {} } });
-      let version = "unknown";
-      try {
-        const stylelintPath = require.resolve("stylelint");
-        const pkgPath = import_path.default.join(import_path.default.dirname(stylelintPath), "..", "package.json");
-        const pkgJson = JSON.parse(import_fs.default.readFileSync(pkgPath, "utf-8"));
-        version = pkgJson.version ?? "unknown";
-      } catch {
-      }
+      const version = (0, import_tooling2.payloadPackageVersion)(payload.root, "stylelint") ?? payload.version;
       ctx.logger.debug("Availability check result", { toolId: TOOL_ID, available: true, version });
-      return { available: true, version, installation: "bundled" };
+      return { available: true, version, path: payload.root, installation: payload.source };
     } catch (err) {
       const reason = `stylelint package not loadable: ${err instanceof Error ? err.message : String(err)}`;
       ctx.logger.debug("Availability check result", { toolId: TOOL_ID, available: false, reason });
@@ -3669,12 +3685,12 @@ var adapter = {
     }
   },
   /**
-   * No-op — Stylelint is an npm dependency and requires no runtime installation.
+   * Installs the pinned Stylelint payload into the Codacy-managed directory
+   * with `npm ci` against the committed lockfile. Refuses in container mode.
    */
   async install(ctx) {
     ctx.logger.info("Starting install", { toolId: TOOL_ID });
-    ctx.logger.info("Install not needed \u2014 npm dependency", { toolId: TOOL_ID });
-    return { success: true, installedVersion: adapter.preferredVersion };
+    return (0, import_tooling2.installNpmPayload)(ctx, PAYLOAD);
   },
   /**
    * Looks for any of the standard Stylelint config file names in the
@@ -3683,7 +3699,7 @@ var adapter = {
   async checkLocalConfigurationFile(ctx) {
     ctx.logger.debug("Checking for local config", { toolId: TOOL_ID });
     for (const name of LOCAL_CONFIG_FILES) {
-      const candidate = import_path.default.join(ctx.repositoryRoot, name);
+      const candidate = import_path2.default.join(ctx.repositoryRoot, name);
       try {
         import_fs.default.accessSync(candidate);
         ctx.logger.debug("Local config check", { toolId: TOOL_ID, found: true, path: candidate });
@@ -3708,14 +3724,16 @@ var adapter = {
     const startedAt = /* @__PURE__ */ new Date();
     const issues = [];
     const errors = [];
-    const absoluteFiles = ctx.targetFiles.map((f) => import_path.default.resolve(ctx.repositoryRoot, f));
+    const absoluteFiles = ctx.targetFiles.map((f) => import_path2.default.resolve(ctx.repositoryRoot, f));
     if (absoluteFiles.length === 0) {
       const completedAt2 = /* @__PURE__ */ new Date();
-      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling2.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
     }
     let stylelint;
+    let payloadRoot;
     try {
-      stylelint = await importStylelint();
+      payloadRoot = (0, import_tooling2.requirePayload)(ctx, PAYLOAD).root;
+      stylelint = await importStylelint(payloadRoot);
     } catch (err) {
       const completedAt2 = /* @__PURE__ */ new Date();
       errors.push({
@@ -3725,24 +3743,28 @@ var adapter = {
         message: `Failed to load stylelint: ${err instanceof Error ? err.message : String(err)}`,
         level: "error"
       });
-      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling2.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
     }
     const lintOptions = { files: absoluteFiles };
     if (codacyConfig.useLocalConfigurationFile && codacyConfig.localConfigurationFile) {
       lintOptions.configFile = codacyConfig.localConfigurationFile;
     } else if (codacyConfig.patterns.length > 0) {
-      lintOptions.config = await buildStylelintConfig(codacyConfig.patterns, ctx.logger);
+      lintOptions.config = await buildStylelintConfig(
+        codacyConfig.patterns,
+        payloadRoot,
+        ctx.logger
+      );
     } else {
       ctx.logger.info("Skipping analysis: no local config and no patterns enabled", {
         toolId: TOOL_ID
       });
-      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, /* @__PURE__ */ new Date(), issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling2.buildResult)(TOOL_ID, startedAt, /* @__PURE__ */ new Date(), issues, errors, ctx.targetFiles.length);
     }
     try {
       const result = await stylelint.lint(lintOptions);
       for (const fileResult of result.results) {
         if (!fileResult.source) continue;
-        const relPath = import_path.default.relative(ctx.repositoryRoot, fileResult.source);
+        const relPath = import_path2.default.relative(ctx.repositoryRoot, fileResult.source);
         for (const warning of fileResult.warnings) {
           if (!warning.rule) {
             errors.push({
@@ -3790,9 +3812,9 @@ var adapter = {
       errorCount: errors.length,
       durationMs: Date.now() - startMs
     });
-    return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt, issues, errors, ctx.targetFiles.length);
+    return (0, import_tooling2.buildResult)(TOOL_ID, startedAt, completedAt, issues, errors, ctx.targetFiles.length);
   }
 };
 
 // src/index.ts
-var index_default = (0, import_tooling2.defineToolAdapter)(adapter);
+var index_default = (0, import_tooling3.defineToolAdapter)(adapter);

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@codacy/tools-stylelint-0",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "Stylelint adapter — Library-mode CSS/SCSS/Less linter",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "payload"
   ],
   "dependencies": {
+    "@codacy/tooling": "0.25.0"
+  },
+  "devDependencies": {
     "@double-great/stylelint-a11y": "^3.0.3",
     "stylelint": "^16.0.0",
     "stylelint-config-standard": "^36.0.0",
-    "stylelint-scss": "^6.12.1",
-    "@codacy/tooling": "0.24.0"
+    "stylelint-scss": "^6.12.1"
   },
   "license": "MIT",
   "author": "Codacy <support@codacy.com> (https://www.codacy.com)",