@codacy/tools-eslint-9 0.23.1 → 0.25.0

package/README.md

@@ -42,11 +42,12 @@ Pattern IDs use the codacy-eslint9 encoding: `_` → `__`, `/` → `_`. Examples
 
 ## Updating the ESLint version
 
-1. Update `eslint` and related packages in `package.json`
+1. Update `eslint` and related packages 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 (`eslint-10/`)
+3. Run `pnpm generate-payloads eslint-9` 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 (`eslint-10/`)
 
 ## Development
 
@@ -82,5 +83,5 @@ pnpm test     # Run tests
 - The `config-builder.ts` generates flat config objects from Codacy patterns, grouping rules by plugin and setting up appropriate parsers. TypeScript files get `@typescript-eslint/parser`; Vue/Svelte/JSONC/YML files get appropriate file globs.
 - When no config or patterns are provided, the adapter falls back to `@eslint/js` recommended config.
 - `checkAvailability` imports the ESLint class and returns `ESLint.version`.
-- `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`.
 - Peer dependency warnings from plugins not yet updated for ESLint 9 are expected and match the codacy-eslint9 wrapper behavior.