@sushichan044/eslint-todo 0.0.2 → 0.0.4

package/README.md

@@ -1,33 +1,35 @@
 # @sushichan044/eslint-todo
 
-> [!WARNING]
+Simple tool to temporarily disable existing ESLint violations like `.rubocop_todo.yml` in RuboCop.
+
+It also has a utility that helps reducing ignored violations at your pace.
+
+> [!NOTE]
 > This tool only supports ESLint Flat Config with ES Module.
 >
 > If you want to use this tool to supress ESLint errors when migrating to ESLint Flat Config,
 > you first need to create Flat Config and then use this tool. Maybe utilities like [@eslint/compat](https://github.com/eslint/rewrite/tree/main/packages/compat) can help you.
 
-Simple tool to temporarily disable existing ESLint violations like `.rubocop_todo.yml` in RuboCop.
-
-This allows existing offending files to be excluded from scanning on a rule-by-rule basis, which is useful when making destructive changes to ESLint settings.
-
-It also has a utility that reduces the number of ignored rules at a pace that works for your team.
-
-## Features
-
-- Temporarily disable ESLint rules for specific files having existing violations with one command.
-- Assistive feature to gradually eliminate ignored errors.
-
 ## Installation
 
 ```bash
-pnpm install -D @sushichan044/eslint-todo
+npm install --save-dev eslint @sushichan044/eslint-todo
 ```
 
+Requires:
+
+- **ES Module**
+- ESLint: `^8.57.0 || ^9.0.0`
+  - **Flat Config**
+- Node.js: `>= 20.0.0`
+  - May work in Deno, but not tested.
+
 ## Getting Started
 
-1. Add `eslint-todo` config to your `eslint.config.js`.
+1. Add `eslint-todo` config **at the bottom of your configs**. Do not forget `await`.
 
     ``` diff
+    // example: eslint.config.js
     + import { eslintConfigTodo } from '@sushichan044/eslint-todo/eslint';
 
     export default [
@@ -36,16 +38,13 @@ pnpm install -D @sushichan044/eslint-todo
     ]
     ```
 
-2. Run `eslint-todo` to generate ESLint Todo file. By default, it will generate `.eslint-todo.js` file.
-
-    > [!NOTE]
-    > Run this command at the directory where your `eslint.config.js` is located.
+2. Run `eslint-todo` to generate ESLint Todo file at the directory where `eslint.config.js` is placed.
 
     ```bash
-    pnpm exec eslint-todo
+    npx eslint-todo
     ```
 
-3. Ignore `.eslint-todo.js` with some tools like Prettier as it is auto-generated module.
+3. Ignore generated `.eslint-todo.js` in some tools if  you needed.
 
     ```diff
     // example: .prettierignore
@@ -67,10 +66,10 @@ Add `--correct` flag to launch eslint-todo with error reduction mode.
 In this mode, eslint-todo searches the todo file with the limit from CLI and removes one matching rule from the todo file.
 This allows ESLint to detect that rule as a violation again. For safety, only auto-fixable rules are searched by default.
 
-You can use `--limit`, `--limit-type`, `--no-auto-fixable-only` options to control the behavior.
+You can use `--limit`, `--limit-type`, `--auto-fixable-only` options to control the behavior.
 
 Default options are: <br>
-Select one rule that has a total of 100 or fewer violations from auto-fixable rules.
+Select one rule that has a total of 100 or fewer violations from **auto-fixable** rules.
 
 ```bash
 eslint-todo --correct --limit 100 --limit-type violation
@@ -82,10 +81,10 @@ Select one rule that has a total of 10 or fewer files with violations from auto-
 eslint-todo --correct --limit 10 --limit-type file
 ```
 
-Select one rule that has a total of 100 or fewer violations from all rules including non-auto-fixable rules:
+Select one rule that has a total of 100 or fewer violations from **all rules including non-auto-fixable** rules:
 
 ```bash
-eslint-todo --correct --limit 100 --limit-type violation --no-auto-fixable-only
+eslint-todo --correct --limit 100 --limit-type violation --auto-fixable-only false
 ```
 
 ## Configuration (CLI)

package/bin/eslint-todo.mjs

@@ -2,7 +2,4 @@
 // @ts-check
 import { run } from "../dist/cli/index.mjs";
 
-run(process.argv).catch((error) => {
-  console.error(error);
-  process.exit(1);
-});
+await run(process.argv);

package/package.json

@@ -1,15 +1,11 @@
 {
   "name": "@sushichan044/eslint-todo",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/sushichan044/eslint-todo.git"
-  },
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
-  "bin": {
-    "eslint-todo": "bin/eslint-todo.mjs"
-  },
   "module": "./dist/index.mjs",
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
@@ -20,9 +16,17 @@
       "types": "./dist/eslint/index.d.ts"
     }
   },
-  "files": [
-    "dist"
-  ],
+  "bin": {
+    "eslint-todo": "bin/eslint-todo.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sushichan044/eslint-todo.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0"
   },
@@ -31,30 +35,35 @@
     "comlink": "4.4.2",
     "consola": "3.4.0",
     "defu": "6.1.4",
-    "es-toolkit": "1.32.0",
     "jiti": "2.4.2",
     "klona": "2.0.6",
     "magicast": "0.3.5",
     "pathe": "2.0.3",
-    "valibot": "1.0.0-rc.1"
+    "valibot": "1.0.0-rc.3"
   },
   "devDependencies": {
-    "@eslint/config-inspector": "1.0.0",
-    "@types/node": "22.13.4",
+    "@eslint/config-inspector": "1.0.1",
+    "@types/node": "22.13.8",
     "@virtual-live-lab/eslint-config": "2.2.17",
     "@virtual-live-lab/prettier-config": "2.0.16",
     "@virtual-live-lab/tsconfig": "2.1.17",
-    "@vitest/coverage-v8": "3.0.5",
-    "@vitest/eslint-plugin": "1.1.31",
-    "eslint": "9.20.1",
+    "@vitest/coverage-v8": "3.0.7",
+    "@vitest/eslint-plugin": "1.1.36",
+    "eslint": "9.21.0",
     "eslint-flat-config-utils": "2.0.1",
+    "eslint-plugin-import-access": "2.2.2",
+    "eslint-plugin-unicorn": "57.0.0",
     "eslint-typegen": "2.0.0",
-    "pkg-pr-new": "0.0.39",
-    "prettier": "3.5.1",
+    "globals": "16.0.0",
+    "pkg-pr-new": "0.0.40",
+    "pnpm": "10.5.2",
+    "prettier": "3.5.3",
+    "release-it": "18.1.2",
+    "release-it-pnpm": "4.6.4",
     "typescript": "5.7.3",
-    "typescript-eslint": "8.24.0",
-    "unbuild": "3.3.1",
-    "vitest": "3.0.5"
+    "typescript-eslint": "8.25.0",
+    "unbuild": "3.5.0",
+    "vitest": "3.0.7"
   },
   "engines": {
     "node": "^20.0.0 || ^22.0.0 || ^23.0.0"

package/dist/cli/index.d.mts

@@ -1,3 +0,0 @@
-declare const run: (argv: string[]) => Promise<void>;
-
-export { run };

package/dist/cli/index.d.ts

@@ -1,3 +0,0 @@
-declare const run: (argv: string[]) => Promise<void>;
-
-export { run };

package/dist/cli/index.mjs

@@ -1,332 +0,0 @@
-import { defineCommand, runMain } from 'citty';
-import { createConsola } from 'consola';
-import { colorize } from 'consola/utils';
-import { L as LATEST_MODULE_HANDLER, T as TodoModuleV1Handler, E as ESLintTodoCore } from '../shared/eslint-todo.BwJWAS7j.mjs';
-import { launchRemoteESLintTodoCore } from '../remote/client.mjs';
-import { klona } from 'klona/json';
-import { relative } from 'pathe';
-import * as v from 'valibot';
-import 'eslint';
-import 'node:fs';
-import 'node:fs/promises';
-import 'magicast';
-import 'es-toolkit/compat';
-import 'defu';
-import 'node:process';
-import 'jiti';
-import 'comlink';
-import 'comlink/dist/esm/node-adapter.mjs';
-import 'node:url';
-import 'node:worker_threads';
-
-const version = "0.0.2";
-
-const defineAction = (action) => action;
-const NO_INPUT = Symbol("NO_INPUT");
-async function runAction(action, options, input = NO_INPUT) {
-  const { consola, options: coreOptions } = options;
-  const remoteService = launchRemoteESLintTodoCore();
-  const remoteCore = await new remoteService.RemoteESLintTodoCore(coreOptions);
-  const actionApi = {
-    core: remoteCore,
-    logger: consola
-  };
-  try {
-    if (input === NO_INPUT) {
-      return await action(actionApi);
-    }
-    return await action(actionApi, input);
-  } catch (e) {
-    consola.error(e);
-    throw e;
-  } finally {
-    await remoteService.terminate();
-  }
-}
-
-const deleteRule = (currentModule, ruleId) => {
-  const newModule = klona(currentModule);
-  if (Object.hasOwn(newModule.todo, ruleId)) {
-    delete newModule.todo[ruleId];
-  }
-  return newModule;
-};
-
-const deleteRuleAction = defineAction(
-  async ({ core, logger }, input) => {
-    const { ruleId } = input;
-    const currentModule = await core.readTodoModule();
-    if (!LATEST_MODULE_HANDLER.isVersion(currentModule)) {
-      throw new Error(
-        "This action requires the latest version of the todo file."
-      );
-    }
-    logger.info(`Deleting rule ${ruleId} from the todo file ...`);
-    const newModule = deleteRule(currentModule, ruleId);
-    await core.writeTodoModule(newModule);
-  }
-);
-
-const genAction = defineAction(async ({ core, logger }) => {
-  await core.resetTodoModule();
-  logger.start("Running ESLint ...");
-  const lintResults = await core.lint();
-  logger.success("ESLint finished!");
-  logger.start("Generating ESLint todo file ...");
-  const todo = await core.buildTodoFromLintResults(lintResults);
-  await core.writeTodoModule(todo);
-});
-
-const selectRuleBasedOnLimit = (todoModule, limit, options = {}) => {
-  switch (limit.type) {
-    case "file":
-      return selectRuleBasedOnFilesLimit(todoModule, limit, options);
-    case "violation":
-      return selectRuleBasedOnViolationsLimit(todoModule, limit, options);
-    default:
-      const l = limit;
-      throw new Error(`Got unknown limit: ${JSON.stringify(l)}`);
-  }
-};
-const selectRuleBasedOnFilesLimit = (todoModule, limit, options = {}) => {
-  const { count: limitCount } = limit;
-  const { autoFixableOnly = true } = options;
-  let selectedRule = null;
-  let maxFiles = 0;
-  for (const [ruleId, entry] of Object.entries(todoModule.todo)) {
-    if (autoFixableOnly && !entry.autoFix) {
-      continue;
-    }
-    const totalFiles = Object.keys(entry.violations).length;
-    if (totalFiles > maxFiles && totalFiles <= limitCount) {
-      maxFiles = totalFiles;
-      selectedRule = ruleId;
-    }
-  }
-  return selectedRule != null ? { ruleId: selectedRule, success: true } : { success: false };
-};
-const selectRuleBasedOnViolationsLimit = (todoModule, limit, options = {}) => {
-  const { count: limitCount } = limit;
-  const { autoFixableOnly = true } = options;
-  let selectedRule = null;
-  let maxViolations = 0;
-  for (const [ruleId, entry] of Object.entries(todoModule.todo)) {
-    if (autoFixableOnly && !entry.autoFix) {
-      continue;
-    }
-    const totalViolations = Object.values(entry.violations).reduce(
-      (sum, count) => sum + count,
-      0
-    );
-    if (totalViolations > maxViolations && totalViolations <= limitCount) {
-      maxViolations = totalViolations;
-      selectedRule = ruleId;
-    }
-  }
-  return selectedRule != null ? { ruleId: selectedRule, success: true } : { success: false };
-};
-
-const selectRulesToFixAction = defineAction(
-  async ({ core, logger }, input) => {
-    const {
-      limit,
-      options = {
-        autoFixableOnly: true
-      }
-    } = input;
-    const currentModule = await core.readTodoModule();
-    if (!LATEST_MODULE_HANDLER.isVersion(currentModule)) {
-      throw new Error(
-        "This action requires the latest version of the todo file."
-      );
-    }
-    logger.start("Refining ESLint todo file ...");
-    return selectRuleBasedOnLimit(currentModule, limit, options);
-  }
-);
-
-const updateAction = defineAction(async ({ core, logger }) => {
-  const currentModule = await core.readTodoModule();
-  if (!TodoModuleV1Handler.isVersion(currentModule)) {
-    return;
-  }
-  logger.start(
-    "Detected old version of todo file. Automatically upgrading ..."
-  );
-  const nextModule = TodoModuleV1Handler.upgradeToNextVersion(currentModule);
-  if (nextModule === false) {
-    logger.error("Upgrade failed!");
-    return;
-  }
-  await core.writeTodoModule(nextModule);
-  logger.success("Upgrade finished!");
-});
-
-const safeTryNumber = (value) => {
-  const parsed = Number(value);
-  return Number.isNaN(parsed) ? null : parsed;
-};
-
-const resolveCLIContext = (input) => {
-  const todoFilePath = relative(input.cwd, input.todoFileAbsolutePath);
-  return {
-    mode: input.mode.correct ? "correct" : "generate",
-    operation: resolveCLIOperation(input.operation),
-    todoFilePath
-  };
-};
-const limitTypeSchema = v.union([v.literal("violation"), v.literal("file")]);
-const resolveCLIOperation = (input) => {
-  const parsedLimitType = v.safeParse(limitTypeSchema, input.limitType);
-  if (!parsedLimitType.success) {
-    throw new Error("limit-type must be either 'violation' or 'file'");
-  }
-  const limitCount = safeTryNumber(input.limit);
-  if (limitCount === null) {
-    throw new Error("limit must be a number");
-  }
-  const limit = {
-    count: limitCount,
-    type: parsedLimitType.output
-  };
-  return {
-    limit,
-    options: {
-      autoFixableOnly: input.autoFixableOnly
-    }
-  };
-};
-
-const consola = createConsola({ formatOptions: { date: false } });
-const cli = defineCommand({
-  args: {
-    // general options
-    "cwd": {
-      description: "Current working directory (default: .)",
-      required: false,
-      type: "string",
-      valueHint: "path"
-    },
-    "todo-file": {
-      alias: "f",
-      description: "ESLint todo file name (default: .eslint-todo.js)",
-      required: false,
-      type: "string",
-      valueHint: "filename"
-    },
-    // mode toggle
-    "correct": {
-      default: false,
-      description: "Launch the correct mode (default: false)",
-      required: false,
-      type: "boolean"
-    },
-    // operation options
-    "auto-fixable-only": {
-      default: true,
-      description: "Only handle auto-fixable violations. (default: true)",
-      required: false,
-      type: "boolean",
-      valueHint: "boolean"
-    },
-    "limit": {
-      default: "100",
-      description: "Limit the number of violations or files to fix. Only works with --correct. (default: 100)",
-      required: false,
-      type: "string",
-      valueHint: "number"
-    },
-    "limit-type": {
-      default: "violation",
-      description: "Type of limit to apply. Only works with --correct. (default: violation)",
-      required: false,
-      type: "string",
-      valueHint: "violation | file"
-    },
-    // logging
-    "debug": {
-      description: "Enable debug mode",
-      required: false,
-      type: "boolean"
-    },
-    "trace": {
-      description: "Enable trace mode",
-      required: false,
-      type: "boolean"
-    },
-    "verbose": {
-      description: "Enable verbose mode",
-      required: false,
-      type: "boolean"
-    }
-  },
-  meta: {
-    description: "Generate ESLint todo file and temporally suppress ESLint errors!",
-    name: "@sushichan044/eslint-todo/cli",
-    version: version
-  },
-  async run({ args }) {
-    const cliCwd = process.cwd();
-    const options = {
-      cwd: args.cwd,
-      todoFile: args["todo-file"]
-    };
-    const eslintTodoCore = new ESLintTodoCore(options);
-    const ctx = resolveCLIContext({
-      cwd: cliCwd,
-      mode: {
-        correct: args.correct
-      },
-      operation: {
-        autoFixableOnly: args["auto-fixable-only"],
-        limit: args.limit,
-        limitType: args["limit-type"]
-      },
-      todoFileAbsolutePath: eslintTodoCore.getTodoModulePath().absolute
-    });
-    await runAction(updateAction, { consola, options });
-    if (ctx.mode === "generate") {
-      await runAction(genAction, { consola, options });
-      consola.success(`ESLint todo file generated at ${ctx.todoFilePath}!`);
-      return;
-    }
-    if (ctx.mode === "correct") {
-      const selection = await runAction(
-        selectRulesToFixAction,
-        { consola, options },
-        ctx.operation
-      );
-      if (!selection.success) {
-        consola.warn(
-          "Couldn't find any rule to fix. Increase the limit and retry."
-        );
-        return;
-      }
-      await runAction(
-        deleteRuleAction,
-        { consola, options },
-        { ruleId: selection.ruleId }
-      );
-      consola.success(
-        `Rule ${colorize("magenta", selection.ruleId)} deleted from the todo file and now ESLint will detect the violations.`
-      );
-      return;
-    }
-    throw new Error(`Unknown mode: ${JSON.stringify(ctx.mode)}`);
-  },
-  setup({ args }) {
-    consola.info(`eslint-todo CLI ${version}`);
-    if (args.debug === true) {
-      consola.level = 4;
-    } else if (args.trace === true) {
-      consola.level = 5;
-    } else if (args.verbose === true) {
-      consola.level = 999;
-    }
-  }
-});
-const run = async (argv) => {
-  await runMain(cli, { rawArgs: argv });
-};
-
-export { run };

package/dist/eslint/index.d.mts

@@ -1,11 +0,0 @@
-import { Linter } from 'eslint';
-import { U as UserOptions } from '../shared/eslint-todo.BijUMnSZ.mjs';
-
-declare const eslintConfigTodo: (userOptions?: UserOptions) => Promise<Linter.Config[]>;
-/**
- * @deprecated
- * You should import this from default export.
- */
-declare const _old_eslintConfigTodo: (userOptions?: UserOptions) => Promise<Linter.Config[]>;
-
-export { eslintConfigTodo as default, _old_eslintConfigTodo as eslintConfigTodo };

package/dist/eslint/index.d.ts

@@ -1,11 +0,0 @@
-import { Linter } from 'eslint';
-import { U as UserOptions } from '../shared/eslint-todo.BijUMnSZ.js';
-
-declare const eslintConfigTodo: (userOptions?: UserOptions) => Promise<Linter.Config[]>;
-/**
- * @deprecated
- * You should import this from default export.
- */
-declare const _old_eslintConfigTodo: (userOptions?: UserOptions) => Promise<Linter.Config[]>;
-
-export { eslintConfigTodo as default, _old_eslintConfigTodo as eslintConfigTodo };

package/dist/eslint/index.mjs

@@ -1,47 +0,0 @@
-import { E as ESLintTodoCore, T as TodoModuleV1Handler, a as TodoModuleV2Handler, b as buildESLintConfigForModule } from '../shared/eslint-todo.BwJWAS7j.mjs';
-import 'eslint';
-import 'node:fs';
-import 'node:fs/promises';
-import 'pathe';
-import 'magicast';
-import 'es-toolkit/compat';
-import 'valibot';
-import 'defu';
-import 'node:process';
-import 'jiti';
-
-const eslintConfigTodo = async (userOptions = {}) => {
-  const core = new ESLintTodoCore(userOptions);
-  const todoModulePath = core.getTodoModulePath();
-  const module = await (async () => {
-    try {
-      return await core._DO_NOT_USE_DIRECTLY_unsafeReadTodoModule();
-    } catch {
-      return null;
-    }
-  })();
-  const configs = [
-    {
-      files: [todoModulePath.relative],
-      linterOptions: {
-        reportUnusedDisableDirectives: false
-      },
-      name: "@sushichan044/eslint-todo/setup"
-    }
-  ];
-  if (module == null || !TodoModuleV1Handler.isVersion(module) && !TodoModuleV2Handler.isVersion(module)) {
-    configs.push({
-      files: [todoModulePath.relative],
-      name: "@sushichan044/eslint-todo/warning/YOU_ARE_USING_INVALID_TODO_FILE"
-    });
-    return configs;
-  }
-  const builtConfigs = buildESLintConfigForModule(module, "off");
-  if (builtConfigs != null) {
-    configs.push(...builtConfigs);
-  }
-  return configs;
-};
-const _old_eslintConfigTodo = eslintConfigTodo;
-
-export { eslintConfigTodo as default, _old_eslintConfigTodo as eslintConfigTodo };

package/dist/index.d.mts

@@ -1,3 +0,0 @@
-import 'eslint';
-import './shared/eslint-todo.BijUMnSZ.mjs';
-export { E as ESLintTodoCore } from './shared/eslint-todo.B_vRyhWL.mjs';

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-import 'eslint';
-import './shared/eslint-todo.BijUMnSZ.js';
-export { E as ESLintTodoCore } from './shared/eslint-todo.BD1wUnwb.js';

package/dist/index.mjs

@@ -1,11 +0,0 @@
-import 'eslint';
-import 'node:fs';
-import 'node:fs/promises';
-import 'pathe';
-export { E as ESLintTodoCore } from './shared/eslint-todo.BwJWAS7j.mjs';
-import 'magicast';
-import 'es-toolkit/compat';
-import 'valibot';
-import 'defu';
-import 'node:process';
-import 'jiti';

package/dist/remote/client.d.mts

@@ -1,25 +0,0 @@
-import * as Comlink from 'comlink';
-import { RemoteESLintTodoCore } from './core.mjs';
-import '../shared/eslint-todo.BijUMnSZ.mjs';
-import '../shared/eslint-todo.B_vRyhWL.mjs';
-import 'eslint';
-
-type RemoteCore = {
-    RemoteESLintTodoCore: Comlink.Remote<typeof RemoteESLintTodoCore>;
-    terminate: () => Promise<number>;
-};
-/**
- * Launch a remote ESLintTodoCore worker with new process.
- *
- * @example
- * ```ts
- *  const remote = launchRemoteESLintTodoCore();
-    const remoteCore = await new remote.RemoteESLintTodoCore(options);
-    const currentModule = await remoteCore.safeReadTodoModule();
-
-    await remote.terminate();
-    ```
- */
-declare const launchRemoteESLintTodoCore: () => RemoteCore;
-
-export { launchRemoteESLintTodoCore };

package/dist/remote/client.d.ts

@@ -1,25 +0,0 @@
-import * as Comlink from 'comlink';
-import { RemoteESLintTodoCore } from './core.js';
-import '../shared/eslint-todo.BijUMnSZ.js';
-import '../shared/eslint-todo.BD1wUnwb.js';
-import 'eslint';
-
-type RemoteCore = {
-    RemoteESLintTodoCore: Comlink.Remote<typeof RemoteESLintTodoCore>;
-    terminate: () => Promise<number>;
-};
-/**
- * Launch a remote ESLintTodoCore worker with new process.
- *
- * @example
- * ```ts
- *  const remote = launchRemoteESLintTodoCore();
-    const remoteCore = await new remote.RemoteESLintTodoCore(options);
-    const currentModule = await remoteCore.safeReadTodoModule();
-
-    await remote.terminate();
-    ```
- */
-declare const launchRemoteESLintTodoCore: () => RemoteCore;
-
-export { launchRemoteESLintTodoCore };