@sushichan044/eslint-todo 0.0.3 → 0.0.4

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.3",
+  "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,7 +35,6 @@
     "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",
@@ -55,6 +58,8 @@
     "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.25.0",
     "unbuild": "3.5.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,478 +0,0 @@
-import { defineCommand, runMain } from 'citty';
-import { createConsola } from 'consola';
-import { colorize } from 'consola/utils';
-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';
-import 'node:fs';
-import 'node:fs/promises';
-import 'magicast';
-import 'es-toolkit/compat';
-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.3";
-
-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 (error) {
-    consola.error(error);
-    throw error;
-  } finally {
-    await remoteService.terminate();
-  }
-}
-
-const deleteRule = (currentModule, ruleSelection) => {
-  if (!Object.hasOwn(currentModule.todo, ruleSelection.ruleId)) {
-    return currentModule;
-  }
-  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 }, 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();
-  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 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, 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 { count: limitCount } = limit;
-  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 violatedFiles = Object.keys(entry.violations).length;
-    if (violatedFiles > limitCount) {
-      if (allowPartialSelection && partialSelectableRule == null) {
-        partialSelectableRule = ruleId;
-      }
-      continue;
-    }
-    if (violatedFiles > selectedTargetCount) {
-      fullSelectableRule = ruleId;
-      selectedTargetCount = violatedFiles;
-    }
-  }
-  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 { count: limitCount } = limit;
-  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 totalViolationCount = Object.values(entry.violations).reduce(
-      (sum, count) => sum + count,
-      0
-    );
-    if (totalViolationCount > limitCount) {
-      if (allowPartialSelection && partialSelectableRule == null) {
-        partialSelectableRule = ruleId;
-      }
-      continue;
-    }
-    if (totalViolationCount > selectedTargetCount) {
-      fullSelectableRule = ruleId;
-      selectedTargetCount = totalViolationCount;
-    }
-  }
-  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 } = 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: {
-      allowPartialSelection: input.allowPartialSelection,
-      autoFixableOnly: input.autoFixableOnly
-    }
-  };
-};
-
-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: .)",
-      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
-    "allow-partial-selection": {
-      description: "Allow partial selection of violations. Only works with --correct. (default: false)",
-      required: false,
-      type: "boolean",
-      valueHint: "boolean"
-    },
-    "auto-fixable-only": {
-      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 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"]
-      },
-      todoFileAbsolutePath: eslintTodoCore.getTodoModulePath().absolute
-    });
-    await runAction(updateAction, { consola, options });
-    if (context.mode === "generate") {
-      await runAction(genAction, { consola, options });
-      consola.success(`ESLint todo file generated at ${context.todoFilePath}!`);
-      return;
-    }
-    if (context.mode === "correct") {
-      const result = await runAction(
-        selectRulesToFixAction,
-        { consola, options },
-        context.operation
-      );
-      if (!result.success) {
-        consola.warn(
-          "Couldn't find any rule to fix. Increase the limit and retry."
-        );
-        return;
-      }
-      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)}`
-      );
-    }
-    throw new Error(`Unknown mode: ${JSON.stringify(context.mode)}`);
-  },
-  setup({ args }) {
-    consola.info(`eslint-todo CLI ${version}`);
-    switch (true) {
-      case args.debug: {
-        consola.level = 4;
-        break;
-      }
-      case args.trace: {
-        consola.level = 5;
-        break;
-      }
-      case args.verbose: {
-        consola.level = 999;
-        break;
-      }
-    }
-  }
-});
-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.BShlgWEx.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 = [
-    {
-      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/FILE_NOT_FOUND_OR_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.BR1uwV1v.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.DyfNwDMO.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.BShlgWEx.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.BR1uwV1v.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.DyfNwDMO.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 };