@sushichan044/eslint-todo 0.0.1

package/bin/eslint-todo.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+// @ts-check
+import { run } from "../dist/cli.mjs";
+
+run(process.argv).catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/dist/cli.d.mts

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

package/dist/cli.d.ts

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

package/dist/cli.mjs

@@ -0,0 +1,45 @@
+import { defineCommand, runMain } from 'citty';
+import { generateESLintTodo } from './index.mjs';
+import 'eslint';
+import 'node:fs';
+import 'node:fs/promises';
+import 'node:path';
+import 'magicast';
+import './shared/eslint-todo.DYn5wjQX.mjs';
+import 'defu';
+import 'node:process';
+import 'jiti';
+
+const cli = defineCommand({
+  args: {
+    cwd: {
+      description: "Current working directory",
+      required: false,
+      type: "string",
+      valueHint: "path"
+    },
+    "todo-file": {
+      description: "ESLint todo file name",
+      required: false,
+      type: "string",
+      valueHint: "filename"
+    }
+  },
+  meta: {
+    description: "Generate ESLint todo file and temporally suppress ESLint errors!",
+    name: "@sushichan044/eslint-todo/cli",
+    version: "0.0.1"
+  },
+  async run({ args }) {
+    const options = {
+      cwd: args.cwd,
+      todoFile: args["todo-file"]
+    };
+    await generateESLintTodo(options);
+  }
+});
+const run = async (argv) => {
+  await runMain(cli, { rawArgs: argv });
+};
+
+export { run };

package/dist/eslint.d.mts

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

package/dist/eslint.d.ts

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

package/dist/eslint.mjs

@@ -0,0 +1,44 @@
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { o as optionsWithDefault, a as importDefault, e as escapeGlobCharacters } from './shared/eslint-todo.DYn5wjQX.mjs';
+import 'defu';
+import 'node:process';
+import 'jiti';
+
+const eslintConfigTodo = async (userOptions = {}) => {
+  const resolvedOptions = optionsWithDefault(userOptions);
+  const todoPath = path.resolve(resolvedOptions.cwd, resolvedOptions.todoFile);
+  if (!existsSync(todoPath)) {
+    return [];
+  }
+  const todoModule = await importDefault(todoPath);
+  const config = buildESLintFlatConfig({
+    todo: todoModule,
+    ...resolvedOptions
+  });
+  return config;
+};
+const buildESLintFlatConfig = (options) => {
+  const { cwd, todo, todoFile } = options;
+  const configs = [];
+  const relativeTodoFilePath = path.relative(cwd, path.resolve(cwd, todoFile));
+  configs.push({
+    files: [relativeTodoFilePath],
+    linterOptions: {
+      reportUnusedDisableDirectives: false
+    },
+    name: "@sushichan044/eslint-todo/setup"
+  });
+  Object.entries(todo).forEach(([ruleId, entry]) => {
+    configs.push({
+      files: entry.files.map((f) => escapeGlobCharacters(f)),
+      name: `@sushichan044/eslint-todo/todo/${ruleId}`,
+      rules: {
+        [ruleId]: "off"
+      }
+    });
+  });
+  return configs;
+};
+
+export { eslintConfigTodo };

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+import { U as UserOptions } from './shared/eslint-todo.BijUMnSZ.mjs';
+
+declare const generateESLintTodo: (userOptions: UserOptions) => Promise<void>;
+
+export { generateESLintTodo };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { U as UserOptions } from './shared/eslint-todo.BijUMnSZ.js';
+
+declare const generateESLintTodo: (userOptions: UserOptions) => Promise<void>;
+
+export { generateESLintTodo };

package/dist/index.mjs

@@ -0,0 +1,68 @@
+import { ESLint } from 'eslint';
+import { existsSync } from 'node:fs';
+import { writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { parseModule, generateCode } from 'magicast';
+import { o as optionsWithDefault, i as isNonEmptyString } from './shared/eslint-todo.DYn5wjQX.mjs';
+import 'defu';
+import 'node:process';
+import 'jiti';
+
+const generateESLintTodoModule = (eslintTodo) => {
+  const js = `/* eslint-disable */
+/**
+ * Auto generated file by eslint-todo. DO NOT EDIT MANUALLY.
+ */
+
+export default {};
+`;
+  const mod = parseModule(js);
+  mod.exports["default"] = eslintTodo;
+  const { code: jsCode } = generateCode(mod, {
+    format: { objectCurlySpacing: true, tabWidth: 2 }
+  });
+  return `${jsCode}
+`;
+};
+
+const resetTodoFile = async (todoFilePath) => {
+  if (!existsSync(todoFilePath)) {
+    return;
+  }
+  await writeFile(todoFilePath, generateESLintTodoModule({}));
+};
+const runESLintLinting = async (eslint, options) => eslint.lintFiles(path.resolve(options.cwd, "**/*"));
+const aggregateESLintTodoByRuleId = (results, options) => {
+  return results.reduce((acc, lintResult) => {
+    for (const message of lintResult.messages) {
+      if (!isNonEmptyString(message.ruleId)) {
+        continue;
+      }
+      acc[message.ruleId] ??= {
+        autoFix: false,
+        files: []
+      };
+      if (Object.prototype.hasOwnProperty.call(acc, message.ruleId)) {
+        acc[message.ruleId].files.push(
+          path.relative(options.cwd, lintResult.filePath)
+        );
+        acc[message.ruleId].autoFix = message.fix != null;
+      }
+    }
+    return acc;
+  }, {});
+};
+const generateESLintTodo = async (userOptions) => {
+  const resolvedOptions = optionsWithDefault(userOptions);
+  const resolvedTodoPath = path.resolve(
+    resolvedOptions.cwd,
+    resolvedOptions.todoFile
+  );
+  await resetTodoFile(resolvedTodoPath);
+  const eslint = new ESLint();
+  const results = await runESLintLinting(eslint, resolvedOptions);
+  const todoByRuleId = aggregateESLintTodoByRuleId(results, resolvedOptions);
+  await writeFile(resolvedTodoPath, generateESLintTodoModule(todoByRuleId));
+};
+
+export { generateESLintTodo };

package/dist/shared/eslint-todo.BijUMnSZ.d.mts

@@ -0,0 +1,16 @@
+type Options = {
+    /**
+     * The file path to read and write the ESLint todo list.
+     * @default ".eslint-todo.js"
+     */
+    todoFile: string;
+    /**
+     * The current working directory.
+     *
+     * @default process.cwd()
+     */
+    cwd: string;
+};
+type UserOptions = Partial<Options>;
+
+export type { UserOptions as U };

package/dist/shared/eslint-todo.BijUMnSZ.d.ts

@@ -0,0 +1,16 @@
+type Options = {
+    /**
+     * The file path to read and write the ESLint todo list.
+     * @default ".eslint-todo.js"
+     */
+    todoFile: string;
+    /**
+     * The current working directory.
+     *
+     * @default process.cwd()
+     */
+    cwd: string;
+};
+type UserOptions = Partial<Options>;
+
+export type { UserOptions as U };

package/dist/shared/eslint-todo.DYn5wjQX.mjs

@@ -0,0 +1,24 @@
+import { defu } from 'defu';
+import { cwd } from 'node:process';
+import { createJiti } from 'jiti';
+
+const optionsWithDefault = (options = {}) => {
+  return defu(options, defaultOptions);
+};
+const defaultOptions = {
+  cwd: cwd(),
+  todoFile: ".eslint-todo.js"
+};
+
+const jiti = createJiti(import.meta.url);
+const importDefault = async (url) => {
+  return await jiti.import(url, { default: true });
+};
+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, "\\!");
+};
+const isNonEmptyString = (maybeString) => {
+  return maybeString != null && maybeString !== "";
+};
+
+export { importDefault as a, escapeGlobCharacters as e, isNonEmptyString as i, optionsWithDefault as o };

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@sushichan044/eslint-todo",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sushichan044/eslint-todo.git"
+  },
+  "version": "0.0.1",
+  "type": "module",
+  "bin": {
+    "eslint-todo": "bin/eslint-todo.mjs"
+  },
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./cli": {
+      "import": "./dist/cli.mjs",
+      "types": "./dist/cli.d.ts"
+    },
+    "./eslint": {
+      "import": "./dist/eslint.mjs",
+      "types": "./dist/eslint.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "eslint": "^8.57.0 || ^9.0.0"
+  },
+  "dependencies": {
+    "citty": "0.1.6",
+    "defu": "6.1.4",
+    "jiti": "2.4.2",
+    "magicast": "0.3.5"
+  },
+  "devDependencies": {
+    "@types/node": "22.13.0",
+    "@virtual-live-lab/eslint-config": "2.2.16",
+    "@virtual-live-lab/prettier-config": "2.0.15",
+    "@virtual-live-lab/tsconfig": "2.1.16",
+    "eslint": "9.19.0",
+    "prettier": "3.4.2",
+    "typescript": "5.7.3",
+    "typescript-eslint": "8.23.0",
+    "unbuild": "3.3.1",
+    "vitest": "3.0.4"
+  },
+  "engines": {
+    "node": "^20.0.0 || ^22.0.0 || ^23.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest",
+    "eslint:inspect": "eslint --inspect-config"
+  }
+}