@sushichan044/eslint-todo 0.0.2 → 0.0.3

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/dist/cli/index.mjs

@@ -1,9 +1,10 @@
 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 { L as LATEST_MODULE_HANDLER, i as isNonEmptyString, T as TodoModuleV1Handler, E as ESLintTodoCore } from '../shared/eslint-todo.BShlgWEx.mjs';
 import { launchRemoteESLintTodoCore } from '../remote/client.mjs';
 import { klona } from 'klona/json';
+import defu from 'defu';
 import { relative } from 'pathe';
 import * as v from 'valibot';
 import 'eslint';
@@ -11,7 +12,6 @@ import 'node:fs';
 import 'node:fs/promises';
 import 'magicast';
 import 'es-toolkit/compat';
-import 'defu';
 import 'node:process';
 import 'jiti';
 import 'comlink';
@@ -19,7 +19,7 @@ import 'comlink/dist/esm/node-adapter.mjs';
 import 'node:url';
 import 'node:worker_threads';
 
-const version = "0.0.2";
+const version = "0.0.3";
 
 const defineAction = (action) => action;
 const NO_INPUT = Symbol("NO_INPUT");
@@ -36,36 +36,53 @@ async function runAction(action, options, input = NO_INPUT) {
       return await action(actionApi);
     }
     return await action(actionApi, input);
-  } catch (e) {
-    consola.error(e);
-    throw e;
+  } catch (error) {
+    consola.error(error);
+    throw error;
   } finally {
     await remoteService.terminate();
   }
 }
 
-const deleteRule = (currentModule, ruleId) => {
-  const newModule = klona(currentModule);
-  if (Object.hasOwn(newModule.todo, ruleId)) {
-    delete newModule.todo[ruleId];
+const deleteRule = (currentModule, ruleSelection) => {
+  if (!Object.hasOwn(currentModule.todo, ruleSelection.ruleId)) {
+    return currentModule;
   }
-  return newModule;
+  if (ruleSelection.type === "full") {
+    const newModule = klona(currentModule);
+    delete newModule.todo[ruleSelection.ruleId];
+    return newModule;
+  }
+  if (ruleSelection.type === "partial") {
+    const newModule = klona(currentModule);
+    const entry = newModule.todo[ruleSelection.ruleId];
+    for (const [file, count] of Object.entries(ruleSelection.violations)) {
+      if (!Object.hasOwn(entry.violations, file)) {
+        continue;
+      }
+      if (entry.violations[file] == null || entry.violations[file] !== count) {
+        continue;
+      }
+      delete entry.violations[file];
+    }
+    return newModule;
+  }
+  const _exhaustiveCheck = ruleSelection;
+  throw new Error(
+    `Unknown rule selection type ${JSON.stringify(_exhaustiveCheck)}`
+  );
 };
 
-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 deleteRuleAction = defineAction(async ({ core }, 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."
+    );
   }
-);
+  const newModule = deleteRule(currentModule, input);
+  await core.writeTodoModule(newModule);
+});
 
 const genAction = defineAction(async ({ core, logger }) => {
   await core.resetTodoModule();
@@ -77,63 +94,154 @@ const genAction = defineAction(async ({ core, logger }) => {
   await core.writeTodoModule(todo);
 });
 
+const operationOptionsWithDefault = (options = {}) => {
+  return defu(options, getDefaultOperationOptions());
+};
+const getDefaultOperationOptions = () => ({
+  allowPartialSelection: false,
+  autoFixableOnly: true
+});
+
 const selectRuleBasedOnLimit = (todoModule, limit, options = {}) => {
+  const resolvedOptions = operationOptionsWithDefault(options);
   switch (limit.type) {
-    case "file":
-      return selectRuleBasedOnFilesLimit(todoModule, limit, options);
-    case "violation":
-      return selectRuleBasedOnViolationsLimit(todoModule, limit, options);
-    default:
+    case "file": {
+      return selectRuleBasedOnFilesLimit(todoModule, limit, resolvedOptions);
+    }
+    case "violation": {
+      return selectRuleBasedOnViolationsLimit(
+        todoModule,
+        limit,
+        resolvedOptions
+      );
+    }
+    default: {
       const l = limit;
       throw new Error(`Got unknown limit: ${JSON.stringify(l)}`);
+    }
   }
 };
-const selectRuleBasedOnFilesLimit = (todoModule, limit, options = {}) => {
+const selectRuleBasedOnFilesLimit = (todoModule, limit, options) => {
   const { count: limitCount } = limit;
-  const { autoFixableOnly = true } = options;
-  let selectedRule = null;
-  let maxFiles = 0;
+  const { allowPartialSelection, autoFixableOnly } = options;
+  if (limitCount <= 0) {
+    throw new Error("The file limit must be greater than 0.");
+  }
+  let fullSelectableRule = null;
+  let selectedTargetCount = 0;
+  let partialSelectableRule = null;
   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;
+    const violatedFiles = Object.keys(entry.violations).length;
+    if (violatedFiles > limitCount) {
+      if (allowPartialSelection && partialSelectableRule == null) {
+        partialSelectableRule = ruleId;
+      }
+      continue;
+    }
+    if (violatedFiles > selectedTargetCount) {
+      fullSelectableRule = ruleId;
+      selectedTargetCount = violatedFiles;
     }
   }
-  return selectedRule != null ? { ruleId: selectedRule, success: true } : { success: false };
+  if (fullSelectableRule != null) {
+    return {
+      selection: {
+        ruleId: fullSelectableRule,
+        type: "full"
+      },
+      success: true
+    };
+  }
+  if (allowPartialSelection && isKeyOfTodo(todoModule.todo, partialSelectableRule)) {
+    const rule = todoModule.todo[partialSelectableRule];
+    const selectedPaths = Object.keys(rule.violations).slice(0, limitCount);
+    const selectedViolations = {};
+    for (const file of selectedPaths) {
+      selectedViolations[file] = rule.violations[file];
+    }
+    return {
+      selection: {
+        ruleId: partialSelectableRule,
+        type: "partial",
+        violations: selectedViolations
+      },
+      success: true
+    };
+  }
+  return { success: false };
 };
-const selectRuleBasedOnViolationsLimit = (todoModule, limit, options = {}) => {
+const selectRuleBasedOnViolationsLimit = (todoModule, limit, options) => {
   const { count: limitCount } = limit;
-  const { autoFixableOnly = true } = options;
-  let selectedRule = null;
-  let maxViolations = 0;
+  const { allowPartialSelection, autoFixableOnly } = options;
+  if (limitCount <= 0) {
+    throw new Error("The violation limit must be greater than 0.");
+  }
+  let fullSelectableRule = null;
+  let selectedTargetCount = 0;
+  let partialSelectableRule = null;
   for (const [ruleId, entry] of Object.entries(todoModule.todo)) {
     if (autoFixableOnly && !entry.autoFix) {
       continue;
     }
-    const totalViolations = Object.values(entry.violations).reduce(
+    const totalViolationCount = Object.values(entry.violations).reduce(
       (sum, count) => sum + count,
       0
     );
-    if (totalViolations > maxViolations && totalViolations <= limitCount) {
-      maxViolations = totalViolations;
-      selectedRule = ruleId;
+    if (totalViolationCount > limitCount) {
+      if (allowPartialSelection && partialSelectableRule == null) {
+        partialSelectableRule = ruleId;
+      }
+      continue;
+    }
+    if (totalViolationCount > selectedTargetCount) {
+      fullSelectableRule = ruleId;
+      selectedTargetCount = totalViolationCount;
     }
   }
-  return selectedRule != null ? { ruleId: selectedRule, success: true } : { success: false };
+  if (fullSelectableRule != null) {
+    return {
+      selection: {
+        ruleId: fullSelectableRule,
+        type: "full"
+      },
+      success: true
+    };
+  }
+  if (allowPartialSelection && isKeyOfTodo(todoModule.todo, partialSelectableRule)) {
+    const rule = todoModule.todo[partialSelectableRule];
+    let selectedCount = 0;
+    const selectedViolations = {};
+    for (const [file, count] of Object.entries(rule.violations)) {
+      if (selectedCount + count > limitCount) {
+        break;
+      }
+      selectedCount += count;
+      selectedViolations[file] = count;
+    }
+    if (Object.keys(selectedViolations).length === 0) {
+      return { success: false };
+    }
+    return {
+      selection: {
+        ruleId: partialSelectableRule,
+        type: "partial",
+        violations: selectedViolations
+      },
+      success: true
+    };
+  }
+  return { success: false };
+};
+const isKeyOfTodo = (todoModule, ruleId) => {
+  return isNonEmptyString(ruleId) && Object.hasOwn(todoModule, ruleId);
 };
 
 const selectRulesToFixAction = defineAction(
   async ({ core, logger }, input) => {
-    const {
-      limit,
-      options = {
-        autoFixableOnly: true
-      }
-    } = input;
+    const { limit, options } = input;
     const currentModule = await core.readTodoModule();
     if (!LATEST_MODULE_HANDLER.isVersion(currentModule)) {
       throw new Error(
@@ -192,6 +300,7 @@ const resolveCLIOperation = (input) => {
   return {
     limit,
     options: {
+      allowPartialSelection: input.allowPartialSelection,
       autoFixableOnly: input.autoFixableOnly
     }
   };
@@ -200,6 +309,13 @@ const resolveCLIOperation = (input) => {
 const consola = createConsola({ formatOptions: { date: false } });
 const cli = defineCommand({
   args: {
+    // IMPORTANT:
+    // do not set default values for boolean options!
+    // CLI flag name is unexpected behavior when default value is set.
+    //
+    // example: `auto-fixable-only` with `default: true` results in
+    // $ eslint-todo --no-auto-fixable-only
+    // because the default value is true, the flag is negated.
     // general options
     "cwd": {
       description: "Current working directory (default: .)",
@@ -222,8 +338,13 @@ const cli = defineCommand({
       type: "boolean"
     },
     // operation options
+    "allow-partial-selection": {
+      description: "Allow partial selection of violations. Only works with --correct. (default: false)",
+      required: false,
+      type: "boolean",
+      valueHint: "boolean"
+    },
     "auto-fixable-only": {
-      default: true,
       description: "Only handle auto-fixable violations. (default: true)",
       required: false,
       type: "boolean",
@@ -272,12 +393,13 @@ const cli = defineCommand({
       todoFile: args["todo-file"]
     };
     const eslintTodoCore = new ESLintTodoCore(options);
-    const ctx = resolveCLIContext({
+    const context = resolveCLIContext({
       cwd: cliCwd,
       mode: {
         correct: args.correct
       },
       operation: {
+        allowPartialSelection: args["allow-partial-selection"],
         autoFixableOnly: args["auto-fixable-only"],
         limit: args.limit,
         limitType: args["limit-type"]
@@ -285,43 +407,67 @@ const cli = defineCommand({
       todoFileAbsolutePath: eslintTodoCore.getTodoModulePath().absolute
     });
     await runAction(updateAction, { consola, options });
-    if (ctx.mode === "generate") {
+    if (context.mode === "generate") {
       await runAction(genAction, { consola, options });
-      consola.success(`ESLint todo file generated at ${ctx.todoFilePath}!`);
+      consola.success(`ESLint todo file generated at ${context.todoFilePath}!`);
       return;
     }
-    if (ctx.mode === "correct") {
-      const selection = await runAction(
+    if (context.mode === "correct") {
+      const result = await runAction(
         selectRulesToFixAction,
         { consola, options },
-        ctx.operation
+        context.operation
       );
-      if (!selection.success) {
+      if (!result.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.`
+      await runAction(deleteRuleAction, { consola, options }, result.selection);
+      if (result.selection.type === "full") {
+        consola.success(
+          `All violations of rule ${colorize(
+            "magenta",
+            result.selection.ruleId
+          )} are deleted from the todo file and now ESLint will detect the violations.`
+        );
+        return;
+      }
+      if (result.selection.type === "partial") {
+        const violationCount = Object.entries(
+          result.selection.violations
+        ).reduce((sum, [, count]) => sum + count, 0);
+        consola.success(
+          `${violationCount} violations of rule ${colorize(
+            "magenta",
+            result.selection.ruleId
+          )} are deleted from the todo file and now ESLint will detect the violations.`
+        );
+        return;
+      }
+      const _exhaustiveCheck = result.selection;
+      throw new Error(
+        `Unknown selection type: ${JSON.stringify(_exhaustiveCheck)}`
       );
-      return;
     }
-    throw new Error(`Unknown mode: ${JSON.stringify(ctx.mode)}`);
+    throw new Error(`Unknown mode: ${JSON.stringify(context.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;
+    switch (true) {
+      case args.debug: {
+        consola.level = 4;
+        break;
+      }
+      case args.trace: {
+        consola.level = 5;
+        break;
+      }
+      case args.verbose: {
+        consola.level = 999;
+        break;
+      }
     }
   }
 });

package/dist/eslint/index.mjs

@@ -1,4 +1,4 @@
-import { E as ESLintTodoCore, T as TodoModuleV1Handler, a as TodoModuleV2Handler, b as buildESLintConfigForModule } from '../shared/eslint-todo.BwJWAS7j.mjs';
+import { E as ESLintTodoCore, T as TodoModuleV1Handler, a as TodoModuleV2Handler, b as buildESLintConfigForModule } from '../shared/eslint-todo.BShlgWEx.mjs';
 import 'eslint';
 import 'node:fs';
 import 'node:fs/promises';
@@ -22,17 +22,17 @@ const eslintConfigTodo = async (userOptions = {}) => {
   })();
   const configs = [
     {
-      files: [todoModulePath.relative],
-      linterOptions: {
-        reportUnusedDisableDirectives: false
-      },
       name: "@sushichan044/eslint-todo/setup"
+    },
+    {
+      ignores: [todoModulePath.relative],
+      name: "@sushichan044/eslint-todo/ignore"
     }
   ];
   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"
+      name: "@sushichan044/eslint-todo/warning/FILE_NOT_FOUND_OR_INVALID_TODO_FILE"
     });
     return configs;
   }

package/dist/index.d.mts

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

package/dist/index.d.ts

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

package/dist/index.mjs

@@ -2,7 +2,7 @@ import 'eslint';
 import 'node:fs';
 import 'node:fs/promises';
 import 'pathe';
-export { E as ESLintTodoCore } from './shared/eslint-todo.BwJWAS7j.mjs';
+export { E as ESLintTodoCore } from './shared/eslint-todo.BShlgWEx.mjs';
 import 'magicast';
 import 'es-toolkit/compat';
 import 'valibot';

package/dist/remote/client.d.mts

@@ -1,7 +1,7 @@
 import * as Comlink from 'comlink';
 import { RemoteESLintTodoCore } from './core.mjs';
 import '../shared/eslint-todo.BijUMnSZ.mjs';
-import '../shared/eslint-todo.B_vRyhWL.mjs';
+import '../shared/eslint-todo.BR1uwV1v.mjs';
 import 'eslint';
 
 type RemoteCore = {

package/dist/remote/client.d.ts

@@ -1,7 +1,7 @@
 import * as Comlink from 'comlink';
 import { RemoteESLintTodoCore } from './core.js';
 import '../shared/eslint-todo.BijUMnSZ.js';
-import '../shared/eslint-todo.BD1wUnwb.js';
+import '../shared/eslint-todo.DyfNwDMO.js';
 import 'eslint';
 
 type RemoteCore = {

package/dist/remote/core.d.mts

@@ -1,18 +1,18 @@
 import { U as UserOptions } from '../shared/eslint-todo.BijUMnSZ.mjs';
-import { I as IESLintTodoCoreLike, S as SupportedModules, R as RuleSeverity, E as ESLintTodoCore } from '../shared/eslint-todo.B_vRyhWL.mjs';
+import { I as IESLintTodoCoreLike, S as SupportedModules, R as RuleSeverity, E as ESLintTodoCore } from '../shared/eslint-todo.BR1uwV1v.mjs';
 import 'eslint';
 
 declare class RemoteESLintTodoCore implements IESLintTodoCoreLike {
     #private;
     constructor(userOptions: UserOptions);
     buildESLintConfig(todoModule: SupportedModules, severity: RuleSeverity): ReturnType<ESLintTodoCore["buildESLintConfig"]>;
-    buildTodoFromLintResults(...params: Parameters<ESLintTodoCore["buildTodoFromLintResults"]>): ReturnType<ESLintTodoCore["buildTodoFromLintResults"]>;
-    getTodoModulePath(...params: Parameters<ESLintTodoCore["getTodoModulePath"]>): ReturnType<ESLintTodoCore["getTodoModulePath"]>;
-    initializeESLint(...params: Parameters<ESLintTodoCore["initializeESLint"]>): ReturnType<ESLintTodoCore["initializeESLint"]>;
-    lint(...params: Parameters<ESLintTodoCore["lint"]>): ReturnType<ESLintTodoCore["lint"]>;
-    readTodoModule(...params: Parameters<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>): ReturnType<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>;
-    resetTodoModule(...params: Parameters<ESLintTodoCore["resetTodoModule"]>): ReturnType<ESLintTodoCore["resetTodoModule"]>;
-    writeTodoModule(...params: Parameters<ESLintTodoCore["writeTodoModule"]>): ReturnType<ESLintTodoCore["writeTodoModule"]>;
+    buildTodoFromLintResults(...parameters: Parameters<ESLintTodoCore["buildTodoFromLintResults"]>): ReturnType<ESLintTodoCore["buildTodoFromLintResults"]>;
+    getTodoModulePath(...parameters: Parameters<ESLintTodoCore["getTodoModulePath"]>): ReturnType<ESLintTodoCore["getTodoModulePath"]>;
+    initializeESLint(...parameters: Parameters<ESLintTodoCore["initializeESLint"]>): ReturnType<ESLintTodoCore["initializeESLint"]>;
+    lint(...parameters: Parameters<ESLintTodoCore["lint"]>): ReturnType<ESLintTodoCore["lint"]>;
+    readTodoModule(...parameters: Parameters<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>): ReturnType<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>;
+    resetTodoModule(...parameters: Parameters<ESLintTodoCore["resetTodoModule"]>): ReturnType<ESLintTodoCore["resetTodoModule"]>;
+    writeTodoModule(...parameters: Parameters<ESLintTodoCore["writeTodoModule"]>): ReturnType<ESLintTodoCore["writeTodoModule"]>;
 }
 
 export { RemoteESLintTodoCore };

package/dist/remote/core.d.ts

@@ -1,18 +1,18 @@
 import { U as UserOptions } from '../shared/eslint-todo.BijUMnSZ.js';
-import { I as IESLintTodoCoreLike, S as SupportedModules, R as RuleSeverity, E as ESLintTodoCore } from '../shared/eslint-todo.BD1wUnwb.js';
+import { I as IESLintTodoCoreLike, S as SupportedModules, R as RuleSeverity, E as ESLintTodoCore } from '../shared/eslint-todo.DyfNwDMO.js';
 import 'eslint';
 
 declare class RemoteESLintTodoCore implements IESLintTodoCoreLike {
     #private;
     constructor(userOptions: UserOptions);
     buildESLintConfig(todoModule: SupportedModules, severity: RuleSeverity): ReturnType<ESLintTodoCore["buildESLintConfig"]>;
-    buildTodoFromLintResults(...params: Parameters<ESLintTodoCore["buildTodoFromLintResults"]>): ReturnType<ESLintTodoCore["buildTodoFromLintResults"]>;
-    getTodoModulePath(...params: Parameters<ESLintTodoCore["getTodoModulePath"]>): ReturnType<ESLintTodoCore["getTodoModulePath"]>;
-    initializeESLint(...params: Parameters<ESLintTodoCore["initializeESLint"]>): ReturnType<ESLintTodoCore["initializeESLint"]>;
-    lint(...params: Parameters<ESLintTodoCore["lint"]>): ReturnType<ESLintTodoCore["lint"]>;
-    readTodoModule(...params: Parameters<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>): ReturnType<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>;
-    resetTodoModule(...params: Parameters<ESLintTodoCore["resetTodoModule"]>): ReturnType<ESLintTodoCore["resetTodoModule"]>;
-    writeTodoModule(...params: Parameters<ESLintTodoCore["writeTodoModule"]>): ReturnType<ESLintTodoCore["writeTodoModule"]>;
+    buildTodoFromLintResults(...parameters: Parameters<ESLintTodoCore["buildTodoFromLintResults"]>): ReturnType<ESLintTodoCore["buildTodoFromLintResults"]>;
+    getTodoModulePath(...parameters: Parameters<ESLintTodoCore["getTodoModulePath"]>): ReturnType<ESLintTodoCore["getTodoModulePath"]>;
+    initializeESLint(...parameters: Parameters<ESLintTodoCore["initializeESLint"]>): ReturnType<ESLintTodoCore["initializeESLint"]>;
+    lint(...parameters: Parameters<ESLintTodoCore["lint"]>): ReturnType<ESLintTodoCore["lint"]>;
+    readTodoModule(...parameters: Parameters<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>): ReturnType<ESLintTodoCore["_DO_NOT_USE_DIRECTLY_unsafeReadTodoModule"]>;
+    resetTodoModule(...parameters: Parameters<ESLintTodoCore["resetTodoModule"]>): ReturnType<ESLintTodoCore["resetTodoModule"]>;
+    writeTodoModule(...parameters: Parameters<ESLintTodoCore["writeTodoModule"]>): ReturnType<ESLintTodoCore["writeTodoModule"]>;
 }
 
 export { RemoteESLintTodoCore };

package/dist/remote/core.mjs

@@ -1,7 +1,7 @@
 import * as Comlink from 'comlink';
 import nodeEndPoint from 'comlink/dist/esm/node-adapter.mjs';
 import { parentPort } from 'node:worker_threads';
-import { E as ESLintTodoCore } from '../shared/eslint-todo.BwJWAS7j.mjs';
+import { E as ESLintTodoCore } from '../shared/eslint-todo.BShlgWEx.mjs';
 import 'eslint';
 import 'node:fs';
 import 'node:fs/promises';
@@ -23,26 +23,28 @@ class RemoteESLintTodoCore {
   buildESLintConfig(todoModule, severity) {
     return this.#todoCore.buildESLintConfig(todoModule, severity);
   }
-  buildTodoFromLintResults(...params) {
-    return this.#todoCore.buildTodoFromLintResults(...params);
+  buildTodoFromLintResults(...parameters) {
+    return this.#todoCore.buildTodoFromLintResults(...parameters);
   }
-  getTodoModulePath(...params) {
-    return this.#todoCore.getTodoModulePath(...params);
+  getTodoModulePath(...parameters) {
+    return this.#todoCore.getTodoModulePath(...parameters);
   }
-  initializeESLint(...params) {
-    return this.#todoCore.initializeESLint(...params);
+  initializeESLint(...parameters) {
+    return this.#todoCore.initializeESLint(...parameters);
   }
-  async lint(...params) {
-    return this.#todoCore.lint(...params);
+  async lint(...parameters) {
+    return this.#todoCore.lint(...parameters);
   }
-  async readTodoModule(...params) {
-    return this.#todoCore._DO_NOT_USE_DIRECTLY_unsafeReadTodoModule(...params);
+  async readTodoModule(...parameters) {
+    return this.#todoCore._DO_NOT_USE_DIRECTLY_unsafeReadTodoModule(
+      ...parameters
+    );
   }
-  async resetTodoModule(...params) {
-    return this.#todoCore.resetTodoModule(...params);
+  async resetTodoModule(...parameters) {
+    return this.#todoCore.resetTodoModule(...parameters);
   }
-  async writeTodoModule(...params) {
-    return this.#todoCore.writeTodoModule(...params);
+  async writeTodoModule(...parameters) {
+    return this.#todoCore.writeTodoModule(...parameters);
   }
 }
 Comlink.expose(

package/dist/shared/{eslint-todo.B_vRyhWL.d.mts → eslint-todo.BR1uwV1v.d.mts}

@@ -82,7 +82,7 @@ type TodoFilePath = {
 
 type MaybePromise<T> = Promise<T> | T;
 type MaybePromisifyAllMethods<T> = {
-    [K in keyof T]: T[K] extends (...args: infer A) => infer R ? R extends PromiseLike<unknown> ? (...args: A) => R : (...args: A) => MaybePromise<R> : T[K];
+    [K in keyof T]: T[K] extends (...arguments_: infer A) => infer R ? R extends PromiseLike<unknown> ? (...arguments_: A) => R : (...arguments_: A) => MaybePromise<R> : T[K];
 };
 
 type ESLintInitializeOptions = Pick<ESLint.Options, "overrideConfig">;

package/dist/shared/{eslint-todo.BwJWAS7j.mjs → eslint-todo.BShlgWEx.mjs}

@@ -18,9 +18,9 @@ const generateTodoModuleCode = (eslintTodo) => {
     "",
     "export default {};"
   ].join("\n");
-  const mod = parseModule(js);
-  mod.exports.default = eslintTodo;
-  const { code: jsCode } = generateCode(mod, {
+  const module_ = parseModule(js);
+  module_.exports.default = eslintTodo;
+  const { code: jsCode } = generateCode(module_, {
     format: { objectCurlySpacing: true, tabWidth: 2 }
   });
   return `${jsCode}
@@ -28,7 +28,7 @@ const generateTodoModuleCode = (eslintTodo) => {
 };
 
 const escapeGlobCharacters = (glob) => {
-  return glob.replace(/\\/g, "\\\\").replace(/\*/g, "\\*").replace(/\?/g, "\\?").replace(/\[/g, "\\[").replace(/\]/g, "\\]").replace(/\{/g, "\\{").replace(/\}/g, "\\}").replace(/\)/g, "\\)").replace(/\(/g, "\\(").replace(/\!/g, "\\!");
+  return glob.replaceAll("\\", "\\\\").replaceAll("*", String.raw`\*`).replaceAll("?", String.raw`\?`).replaceAll("[", String.raw`\[`).replaceAll("]", String.raw`\]`).replaceAll("{", String.raw`\{`).replaceAll("}", String.raw`\}`).replaceAll(")", String.raw`\)`).replaceAll("(", String.raw`\(`).replaceAll("!", String.raw`\!`);
 };
 const isNonEmptyString = (maybeString) => {
   return typeof maybeString === "string" && maybeString !== "";
@@ -41,7 +41,7 @@ const TodoModuleV2Handler = {
   version: 2,
   buildConfigsForESLint: ({ todo }, severity) => {
     return Object.entries(todo).map(([ruleId, entry]) => ({
-      files: Object.keys(entry.violations).map(escapeGlobCharacters),
+      files: Object.keys(entry.violations).map((f) => escapeGlobCharacters(f)),
       name: `@sushichan044/eslint-todo/${severity}/${ruleId}`,
       rules: {
         [ruleId]: severity
@@ -49,23 +49,23 @@ const TodoModuleV2Handler = {
     }));
   },
   buildTodoFromLintResults(lintResult, options) {
-    return lintResult.reduce((todoMod, result) => {
+    return lintResult.reduce((todoModule, result) => {
       const relativeFilePath = relative(options.cwd, result.filePath);
       for (const message of result.messages) {
         if (!isNonEmptyString(message.ruleId)) {
           continue;
         }
-        todoMod.todo[message.ruleId] ??= {
+        todoModule.todo[message.ruleId] ??= {
           autoFix: false,
           violations: {}
         };
-        todoMod.todo[message.ruleId].violations[relativeFilePath] ??= 0;
-        if (Object.hasOwn(todoMod.todo, message.ruleId)) {
-          todoMod.todo[message.ruleId].violations[relativeFilePath]++;
-          todoMod.todo[message.ruleId].autoFix = message.fix != null;
+        todoModule.todo[message.ruleId].violations[relativeFilePath] ??= 0;
+        if (Object.hasOwn(todoModule.todo, message.ruleId)) {
+          todoModule.todo[message.ruleId].violations[relativeFilePath]++;
+          todoModule.todo[message.ruleId].autoFix = message.fix != null;
         }
       }
-      return todoMod;
+      return todoModule;
     }, TodoModuleV2Handler.getDefaultTodo());
   },
   getDefaultTodo() {
@@ -89,7 +89,7 @@ const TodoModuleV1Handler = {
   version: 1,
   buildConfigsForESLint: (todo, severity) => {
     return Object.entries(todo).map(([ruleId, entry]) => ({
-      files: entry.files.map(escapeGlobCharacters),
+      files: entry.files.map((f) => escapeGlobCharacters(f)),
       name: `@sushichan044/eslint-todo/${severity}/${ruleId}`,
       rules: {
         [ruleId]: severity
@@ -97,22 +97,22 @@ const TodoModuleV1Handler = {
     }));
   },
   buildTodoFromLintResults(lintResult, options) {
-    return lintResult.reduce((todoMod, result) => {
+    return lintResult.reduce((todoModule, result) => {
       const relativeFilePath = relative(options.cwd, result.filePath);
       for (const message of result.messages) {
         if (!isNonEmptyString(message.ruleId)) {
           continue;
         }
-        todoMod[message.ruleId] ??= {
+        todoModule[message.ruleId] ??= {
           autoFix: false,
           files: []
         };
-        if (Object.hasOwn(todoMod, message.ruleId)) {
-          todoMod[message.ruleId].files.push(relativeFilePath);
-          todoMod[message.ruleId].autoFix = message.fix != null;
+        if (Object.hasOwn(todoModule, message.ruleId)) {
+          todoModule[message.ruleId].files.push(relativeFilePath);
+          todoModule[message.ruleId].autoFix = message.fix != null;
         }
       }
-      return todoMod;
+      return todoModule;
     }, TodoModuleV1Handler.getDefaultTodo());
   },
   getDefaultTodo() {
@@ -243,4 +243,4 @@ class ESLintTodoCore {
   }
 }
 
-export { ESLintTodoCore as E, LATEST_MODULE_HANDLER as L, TodoModuleV1Handler as T, TodoModuleV2Handler as a, buildESLintConfigForModule as b };
+export { ESLintTodoCore as E, LATEST_MODULE_HANDLER as L, TodoModuleV1Handler as T, TodoModuleV2Handler as a, buildESLintConfigForModule as b, isNonEmptyString as i };

package/dist/shared/{eslint-todo.BD1wUnwb.d.ts → eslint-todo.DyfNwDMO.d.ts}

@@ -82,7 +82,7 @@ type TodoFilePath = {
 
 type MaybePromise<T> = Promise<T> | T;
 type MaybePromisifyAllMethods<T> = {
-    [K in keyof T]: T[K] extends (...args: infer A) => infer R ? R extends PromiseLike<unknown> ? (...args: A) => R : (...args: A) => MaybePromise<R> : T[K];
+    [K in keyof T]: T[K] extends (...arguments_: infer A) => infer R ? R extends PromiseLike<unknown> ? (...arguments_: A) => R : (...arguments_: A) => MaybePromise<R> : T[K];
 };
 
 type ESLintInitializeOptions = Pick<ESLint.Options, "overrideConfig">;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/sushichan044/eslint-todo.git"
   },
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "bin": {
     "eslint-todo": "bin/eslint-todo.mjs"
@@ -36,25 +36,29 @@
     "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",
     "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"