@morev/eslint-disable-autofix 1.0.0

package/LICENSE.md

@@ -0,0 +1,14 @@
+# The MIT License (MIT)
+
+Copyright © 2025+ [Maxim Morev](https://github.com/MorevM)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+<!-- markdownlint-disable-next-line md033 -->
+<img src="./.github/assets/banner.svg" alt="Promo image of @morev/eslint-disable-autofix package" width="830" height="465" />
+
+![Stability of "master" branch](https://img.shields.io/github/actions/workflow/status/MorevM/eslint-disable-autofix/build.yaml?branch=master)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![Last commit](https://img.shields.io/github/last-commit/morevm/eslint-disable-autofix)
+![Release version](https://img.shields.io/github/v/release/morevm/eslint-disable-autofix?include_prereleases)
+![GitHub Release Date](https://img.shields.io/github/release-date/morevm/eslint-disable-autofix)
+![Keywords](https://img.shields.io/github/package-json/keywords/morevm/eslint-disable-autofix)
+
+# @morev/eslint-disable-autofix
+
+This utility allows you to disable autofix for specific ESLint rules by using a custom prefix in your configurations. \
+It's useful when you want a rule to remain active for linting purposes but prevent ESLint from automatically fixing it.
+
+---
+
+> [!NOTE]
+> This is a temporary solution until [this RFC](https://github.com/eslint/rfcs/pull/134) is accepted
+> and a final implementation is made that closes [this issue](https://github.com/eslint/eslint/issues/18696) -
+> after that the feature for disabling autofix for rules will be in the ESLint core.
+>
+> I am working on RFC development and final implementation in the core myself,
+> but the process will take some time, and the problem is already there.
+>
+> I'll probably be able to implement this as a polyfill for the final solution,
+> once [the RFC](https://github.com/eslint/rfcs/pull/134) discussion reaches
+> a consensus on a public API.
+
+---
+
+> [!IMPORTANT]
+>
+> * Only works with ESLint v9 and its flat config format;
+> * You have to restart ESLint server after adding/removing `no-autofix/` prefix to take effect.
+
+---
+
+## Why?
+
+Some rules support autofixing, which is often convenient, but in certain cases
+the fixes may be broken, unsafe, or simply undesirable. \
+Ideally, unsafe autofixes should be treated as suggestions, and broken fixes should be reported.
+
+However, ESLint is a large ecosystem, and some useful plugins are no longer actively maintained. \
+Even in actively maintained projects, users may want to disable autofixing for specific rules
+due to project-specific or personal preferences.
+
+## Installation
+
+```bash
+pnpm add -D @morev/eslint-disable-autofix
+```
+
+```bash
+yarn add @morev/eslint-disable-autofix -D
+```
+
+```bash
+npm install -D @morev/eslint-disable-autofix
+```
+
+## Usage
+
+### Basic usage
+
+In your `eslint.config.js` (only flat config is supported):
+
+```js
+import { disableAutofix } from '@morev/eslint-disable-autofix';
+import somePlugin from 'some-eslint-plugin';
+
+export default disableAutofix([
+  {
+    plugins: {
+      'some-plugin': somePlugin,
+    },
+    rules: {
+      // Disable autofix for a core rule
+      'no-autofix/no-var': 'error',
+      // Disable autofix for a third-party rule
+      'no-autofix/some-plugin/some-rule': 'warn',
+    },
+  },
+]);
+```
+
+### Custom prefix
+
+If you'd prefer a custom prefix other than `no-autofix/`, use the factory:
+
+```js
+import { createDisableAutofix } from '@morev/eslint-disable-autofix';
+
+const disableAutofix = createDisableAutofix({
+  prefix: 'disable-autofix',
+});
+
+export default disableAutofix([
+  {
+    rules: {
+      'disable-autofix/no-var': 'error',
+    },
+  },
+]);
+```
+
+## How it works internally
+
+1. Scans passed ESLint configurations for rules with a specified prefix;
+1. Strips the prefix to keep the original name of the rule;
+1. Patches rules from ESLint core or third-party plugins directly to disable autofix.
+
+Under the hood, it uses [`eslint-rule-composer`](https://github.com/not-an-aardvark/eslint-rule-composer)
+to wrap rules with autofix disabled.
+
+>[!CAUTION]
+> Direct patching is quite risky and hacky, it relies on non-public ESLint API. \
+> While it's currently the only way to access certain rule internals,
+> it may break in future ESLint versions.
+
+## Alternatives
+
+I've been using [eslint-plugin-no-autofix](https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix)
+for a long time and haven't had much trouble with it, however recently problems have arisen:
+
+1. Some popular plugins (like [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
+   or [eslint-stylistic](https://github.com/eslint-stylistic/eslint-stylistic))
+   switch to the ESM-only distribution format and
+   [eslint-plugin-no-autofix](https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix) doesn't work with it.
+   The [issue have no response](https://github.com/aladdin-add/eslint-plugin/issues/104),
+   so I've decided to create my own solution that works in a different way.
+1. I'm getting tired of rules being renamed just to make them work. \
+   Say I need to disable a rule with autofix turned off for a single file - I write `/* eslint-disable no-autofix/unicorn/no-lonely-if */`. \
+   Later, the broken autofix in the original rule gets fixed, I re-enable the main rule,
+   and now the directive no longer applies, which leads to unexpected changes I didn't want.
+
+   Patching the original rules instead of creating new ones might be a bit riskier technically,
+   but from a developer experience perspective, it's definitely cleaner and more intuitive.

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@morev/eslint-disable-autofix",
+  "description": "Utility to disable autofix for specific ESLint rules",
+  "type": "module",
+  "private": false,
+  "version": "1.0.0",
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": {
+    "name": "Maxim Morev",
+    "email": "max.seainside@gmail.com"
+  },
+  "homepage": "https://github.com/MorevM/eslint-disable-autofix#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MorevM/eslint-disable-autofix"
+  },
+  "keywords": [
+    "eslint",
+    "autofix",
+    "no-autofix",
+    "disable-autofix"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "peerDependencies": {
+    "eslint": "^9.0.0"
+  },
+  "dependencies": {
+    "@morev/utils": "^3.12.2",
+    "eslint-rule-composer": "^0.3.0"
+  },
+  "devDependencies": {
+    "@morev/commitlint-config": "^0.2.2",
+    "@morev/eslint-config": "^38.1.0",
+    "@morev/stylelint-config": "^7.1.0",
+    "@release-it/conventional-changelog": "^8.0.1",
+    "@types/node": "^22.15.18",
+    "eslint": "9.27.0",
+    "eslint-plugin-unicorn": "^59.0.1",
+    "lefthook": "^1.11.13",
+    "release-it": "^19.0.2",
+    "stylelint": "^16.19.1",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3"
+  },
+  "scripts": {
+    "test": "vitest",
+    "test:dev": "vitest --watch",
+    "lint": "eslint \"**/*.{js,ts,vue,json,json5,jsonc,yml,yaml,md}\"",
+    "lint:fix": "eslint \"**/*.{js,ts,vue,json,json5,jsonc,yml,yaml,md}\" --fix",
+    "build": "rm -rf dist && tsup",
+    "release": "release-it --disable-metrics"
+  }
+}