eslint-interactive 9.0.0 → 10.2.0

package/package.json

@@ -1,68 +1,64 @@
 {
   "name": "eslint-interactive",
   "description": "The CLI tool to run `eslint --fix` for each rule",
-  "version": "9.0.0",
+  "version": "10.2.0",
   "repository": "https://github.com/mizdra/eslint-interactive.git",
   "author": "mizdra <pp.mizdra@gmail.com>",
   "license": "MIT",
   "private": false,
   "type": "module",
-  "exports": "./dist/index.js",
-  "scripts": {
-    "build": "tsc -p tsconfig.src.json",
-    "dev": "tsc-watch -p tsconfig.src.json --onSuccess 'bin/eslint-interactive.js fixtures --rulesdir fixtures/rules --ext .js,.jsx,.mjs'",
-    "lint": "run-s -c lint:*",
-    "lint:tsc": "run-s -c lint:tsc:*",
-    "lint:tsc:src": "tsc -p tsconfig.src.json --noEmit",
-    "lint:tsc:test": "tsc -p tsconfig.test.json --noEmit",
-    "lint:eslint": "eslint --ignore-pattern '/fixtures/' --ignore-pattern '/e2e-test/' .",
-    "lint:prettier": "prettier --check .",
-    "test": "FORCE_HYPERLINK=1 NODE_OPTIONS=--experimental-vm-modules jest --colors",
-    "postbuild:test": "./run-e2e-test.sh",
-    "postbuild:benchmark": "node benchmark/run.js"
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
   },
   "prettier": "@mizdra/prettier-config-mizdra",
-  "renovate": "github>mizdra/renovate-config-mizdra",
+  "packageManager": "pnpm@7.5.1",
   "devDependencies": {
-    "@jest/types": "^27.5.1",
-    "@mizdra/eslint-config-mizdra": "^1.1.0",
-    "@mizdra/prettier-config-mizdra": "^0.4.0",
-    "@types/eslint": "^8.4.1",
+    "@babel/core": "^7.18.13",
+    "@babel/preset-typescript": "^7.18.6",
+    "@jest/types": "^29.0.1",
+    "@mizdra/eslint-config-mizdra": "^1.2.0",
+    "@mizdra/prettier-config-mizdra": "^1.0.0",
+    "@types/eslint": "^8.4.6",
     "@types/estraverse": "^5.1.1",
-    "@types/estree": "^0.0.51",
-    "@types/jest": "^27.0.3",
-    "@types/node": "^14.14.10",
+    "@types/estree": "^1.0.0",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^18.0.5",
     "@types/terminal-link": "^1.2.0",
-    "@types/yargs": "^16.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.16.0",
-    "@typescript-eslint/parser": "^5.16.0",
-    "enhanced-resolve": "^5.8.3",
-    "eslint": "^8.11.0",
+    "@types/yargs": "^17.0.10",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "babel-jest": "^29.0.1",
+    "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.25.4",
-    "jest": "^27.5.1",
-    "jest-mock-process": "^1.4.1",
+    "eslint-plugin-import": "^2.26.0",
+    "jest": "^29.0.1",
+    "jest-mock-process": "^2.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.6.0",
+    "prettier": "2.7.1",
+    "resolve-from": "^5.0.0",
     "strip-ansi": "^7.0.1",
-    "ts-jest": "^27.1.3",
-    "tsc-watch": "^4.2.9",
-    "typescript": "^4.6.0-dev.20220211"
+    "tsc-watch": "^5.0.3",
+    "typescript": "^4.8.2"
   },
   "dependencies": {
-    "boxen": "^6.2.1",
+    "boxen": "^7.0.0",
     "cachedir": "^2.3.0",
-    "chalk": "^5.0.0",
+    "chalk": "^5.0.1",
     "comlink": "^4.3.1",
     "enquirer": "^2.3.6",
     "eslint-formatter-codeframe": "^7.32.1",
     "estraverse": "^5.3.0",
     "is-installed-globally": "^0.4.0",
     "node-pager": "^0.3.6",
-    "ora": "^6.0.1",
+    "ora": "^6.1.2",
     "table": "^6.8.0",
     "terminal-link": "^3.0.0",
-    "yargs": "^16.2.0"
+    "yargs": "^17.5.1"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0"
@@ -88,5 +84,18 @@
     "!src/**/__snapshots__",
     "dist",
     "static"
-  ]
-}
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.src.json",
+    "dev": "tsc-watch -p tsconfig.src.json --onSuccess 'bin/eslint-interactive.js fixtures --rulesdir fixtures/rules --ext .js,.jsx,.mjs'",
+    "lint": "run-s -c lint:*",
+    "lint:tsc": "run-s -c lint:tsc:*",
+    "lint:tsc:src": "tsc -p tsconfig.src.json --noEmit",
+    "lint:tsc:test": "tsc -p tsconfig.test.json --noEmit",
+    "lint:eslint": "eslint --ignore-pattern '/fixtures/' --ignore-pattern '/e2e-test/' .",
+    "lint:prettier": "prettier --check .",
+    "test": "FORCE_HYPERLINK=1 NODE_OPTIONS=\"--experimental-vm-modules --experimental-import-meta-resolve $NODE_OPTIONS\" jest --colors",
+    "postbuild:test": "./run-e2e-test.sh",
+    "postbuild:benchmark": "node benchmark/run.js"
+  }
+}

package/src/action/convert-error-to-warning-per-file.ts

@@ -0,0 +1,18 @@
+import { Remote } from 'comlink';
+import { ESLint } from 'eslint';
+import { fixingSpinner } from '../cli/ora.js';
+import { promptToInputDescription } from '../cli/prompt.js';
+import { SerializableCore } from '../core-worker.js';
+import { Undo } from '../core.js';
+
+export async function doConvertErrorToWarningPerFileAction(
+  core: Remote<SerializableCore>,
+  results: ESLint.LintResult[],
+  selectedRuleIds: string[],
+): Promise<Undo> {
+  const description = await promptToInputDescription();
+  const undo = await fixingSpinner(async () =>
+    core.convertErrorToWarningPerFile(results, selectedRuleIds, description),
+  );
+  return undo;
+}

package/src/action/index.ts

@@ -1,6 +1,7 @@
 export { doApplySuggestionsAction } from './apply-suggestions.js';
 export { doDisablePerFileAction } from './disable-per-file.js';
 export { doDisablePerLineAction } from './disable-per-line.js';
+export { doConvertErrorToWarningPerFileAction } from './convert-error-to-warning-per-file.js';
 export { doFixAction } from './fix.js';
 export { doMakeFixableAndFixAction } from './make-fixable-and-fix.js';
 export { doPrintResultDetailsAction } from './print-result-details.js';

package/src/cli/parse-argv.ts

@@ -22,6 +22,11 @@ export function parseArgv(argv: string[]): Config {
       describe: 'Specify the format to be used for the `Display problem messages` action',
       default: DEFAULT_BASE_CONFIG.formatterName,
     })
+    .option('quiet', {
+      type: 'boolean',
+      describe: 'Report errors only',
+      default: DEFAULT_BASE_CONFIG.quiet,
+    })
     .option('cache', {
       type: 'boolean',
       describe: 'Only check changed files',
@@ -31,7 +36,8 @@ export function parseArgv(argv: string[]): Config {
       type: 'string',
       describe: `Path to the cache file or directory`,
       default: DEFAULT_BASE_CONFIG.cacheLocation,
-    }).argv;
+    })
+    .parseSync();
   // NOTE: convert `string` type because yargs convert `'10'` (`string` type) into `10` (`number` type)
   // and `lintFiles` only accepts `string[]`.
   const patterns = parsedArgv._.map((pattern) => pattern.toString());
@@ -46,6 +52,7 @@ export function parseArgv(argv: string[]): Config {
     rulePaths,
     extensions,
     formatterName,
+    quiet: parsedArgv.quiet,
     cache: parsedArgv.cache,
     cacheLocation: parsedArgv['cache-location'],
   };

package/src/cli/prompt.ts

@@ -18,6 +18,7 @@ export type Action =
   | 'applyAutoFixes'
   | 'disablePerLine'
   | 'disablePerFile'
+  | 'convertErrorToWarningPerFile'
   | 'applySuggestions'
   | 'makeFixableAndFix'
   | 'reselectRules';
@@ -82,6 +83,7 @@ export async function promptToInputAction(
     { name: 'applyAutoFixes', message: '🔧 Run `eslint --fix`', disabled: foldedStatistics.isFixableCount === 0 },
     { name: 'disablePerLine', message: '🔧 Disable per line' },
     { name: 'disablePerFile', message: '🔧 Disable per file' },
+    { name: 'convertErrorToWarningPerFile', message: '🔧 Convert error to warning per file' },
     {
       name: 'applySuggestions',
       message: '🔧 Apply suggestions (experimental, for experts)',
@@ -132,7 +134,7 @@ export async function promptToInputDisplayMode(): Promise<DisplayMode> {
 }
 
 /**
- * Ask the user a description to leave in disable comment.
+ * Ask the user a description to leave in directive.
  * @returns The description
  */
 export async function promptToInputDescription(): Promise<string | undefined> {
@@ -142,7 +144,7 @@ export async function promptToInputDescription(): Promise<string | undefined> {
     {
       name: 'description',
       type: 'input',
-      message: 'Leave a code comment with your reason for disabling (Optional)',
+      message: 'Leave a code comment with your reason for fixing (Optional)',
       onCancel,
     },
   ]);

package/src/core-worker.ts

@@ -40,6 +40,11 @@ export class SerializableCore {
   async disablePerFile(...args: Parameters<Core['disablePerFile']>): ReturnType<Core['disablePerFile']> {
     return proxy(await this.core.disablePerFile(...args));
   }
+  async convertErrorToWarningPerFile(
+    ...args: Parameters<Core['convertErrorToWarningPerFile']>
+  ): ReturnType<Core['convertErrorToWarningPerFile']> {
+    return proxy(await this.core.convertErrorToWarningPerFile(...args));
+  }
   async applySuggestions(
     results: ESLint.LintResult[],
     ruleIds: string[],

package/src/core.ts

@@ -1,8 +1,7 @@
 import { join } from 'path';
 import { fileURLToPath } from 'url';
 import { ESLint } from 'eslint';
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-import isInstalledGlobally = require('is-installed-globally');
+import isInstalledGlobally from 'is-installed-globally';
 import { format } from './formatter/index.js';
 import {
   eslintInteractivePlugin,
@@ -51,21 +50,24 @@ async function getUsedRuleIds(targetFilePaths: string[], options: ESLint.Options
 export type Undo = () => Promise<void>;
 
 /** The config of eslint-interactive */
-export type Config = {
+export type Config = Pick<
+  ESLint.Options,
+  'extensions' | 'rulePaths' | 'cache' | 'cacheLocation' | 'useEslintrc' | 'overrideConfig' | 'cwd'
+> & {
   patterns: string[];
-  rulePaths?: string[] | undefined;
-  extensions?: string[] | undefined;
   formatterName?: string;
-  cache?: boolean;
-  cacheLocation?: string;
-  cwd?: string;
+  quiet?: boolean;
 };
 
 /** Default config of `Core` */
-export const DEFAULT_BASE_CONFIG = {
+export const DEFAULT_BASE_CONFIG: Partial<Config> = {
+  cwd: undefined,
   cache: true,
   cacheLocation: join(getCacheDir(), '.eslintcache'),
+  extensions: undefined,
   formatterName: 'codeframe',
+  quiet: false,
+  rulePaths: undefined,
 };
 
 /**
@@ -75,17 +77,15 @@ export const DEFAULT_BASE_CONFIG = {
 export class Core {
   readonly config: Config;
   /** The base options of ESLint */
-  readonly baseOptions: ESLint.Options;
+  readonly baseESLintOptions: ESLint.Options;
 
   constructor(config: Config) {
-    this.config = config;
-    this.baseOptions = {
-      cache: this.config.cache ?? DEFAULT_BASE_CONFIG.cache,
-      cacheLocation: this.config.cacheLocation ?? DEFAULT_BASE_CONFIG.cacheLocation,
-      rulePaths: this.config.rulePaths,
-      extensions: this.config.extensions,
-      cwd: this.config.cwd,
+    this.config = {
+      ...DEFAULT_BASE_CONFIG,
+      ...config,
     };
+    const { patterns, formatterName, quiet, ...baseOptions } = this.config;
+    this.baseESLintOptions = baseOptions;
   }
 
   /**
@@ -93,8 +93,9 @@ export class Core {
    * @returns The results of linting
    */
   async lint(): Promise<ESLint.LintResult[]> {
-    const eslint = new ESLint(this.baseOptions);
-    const results = await eslint.lintFiles(this.config.patterns);
+    const eslint = new ESLint(this.baseESLintOptions);
+    let results = await eslint.lintFiles(this.config.patterns);
+    if (this.config.quiet) results = ESLint.getErrorResults(results);
     return results;
   }
 
@@ -108,8 +109,8 @@ export class Core {
 
     // get `rulesMeta` from `results`
     const eslint = new ESLint({
-      ...this.baseOptions,
-      overrideConfig: { plugins },
+      ...this.baseESLintOptions,
+      overrideConfig: { ...this.baseESLintOptions.overrideConfig, plugins },
     });
     // NOTE: `getRulesMetaForResults` is a feature added in ESLint 7.29.0.
     // Therefore, the function may not exist in versions lower than 7.29.0.
@@ -124,7 +125,7 @@ export class Core {
    * @param ruleIds The rule ids to print details
    */
   async formatResultDetails(results: ESLint.LintResult[], ruleIds: (string | null)[]): Promise<string> {
-    const eslint = new ESLint(this.baseOptions);
+    const eslint = new ESLint(this.baseESLintOptions);
     const formatterName = this.config.formatterName ?? DEFAULT_BASE_CONFIG.formatterName;
 
     // When eslint-interactive is installed globally, eslint-formatter-codeframe will also be installed globally.
@@ -173,6 +174,20 @@ export class Core {
     return await this.fix(results, ruleIds, { name: 'disablePerFile', args: { description } });
   }
 
+  /**
+   * Convert error to warning per file.
+   * @param results The lint results of the project to convert
+   * @param ruleIds The rule ids to convert
+   * @param description The comment explaining the reason for converting
+   */
+  async convertErrorToWarningPerFile(
+    results: ESLint.LintResult[],
+    ruleIds: string[],
+    description?: string,
+  ): Promise<Undo> {
+    return await this.fix(results, ruleIds, { name: 'convertErrorToWarningPerFile', args: { description } });
+  }
+
   /**
    * Apply suggestions.
    * @param results The lint results of the project to apply suggestions
@@ -201,13 +216,13 @@ export class Core {
     // NOTE: Extract only necessary results and files for performance
     const filteredResultsOfLint = filterResultsByRuleId(resultsOfLint, ruleIds);
     const targetFilePaths = filteredResultsOfLint.map((result) => result.filePath);
-    const usedRuleIds = await getUsedRuleIds(targetFilePaths, this.baseOptions);
+    const usedRuleIds = await getUsedRuleIds(targetFilePaths, this.baseESLintOptions);
 
     // TODO: refactor
     let results = filteredResultsOfLint;
     for (let i = 0; i < MAX_AUTOFIX_PASSES; i++) {
       const eslint = new ESLint({
-        ...this.baseOptions,
+        ...this.baseESLintOptions,
         // This is super hack to load ESM plugin/rule.
         // ref: https://github.com/eslint/eslint/issues/15453#issuecomment-1001200953
         plugins: {

package/src/formatter/format-by-rules.ts

@@ -1,7 +1,6 @@
 import chalk from 'chalk';
 import { ESLint } from 'eslint';
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-import table = require('table');
+import table from 'table';
 import terminalLink from 'terminal-link';
 import { ERROR_COLOR } from './colors.js';
 import { takeRuleStatistics } from './take-rule-statistics.js';

package/src/plugin/fix/convert-error-to-warning-per-file.ts

@@ -0,0 +1,45 @@
+import { Rule, Linter } from 'eslint';
+import { unique } from '../../util/array.js';
+import { findShebang, toInlineConfigCommentText } from '../../util/eslint.js';
+import { notEmpty } from '../../util/type-check.js';
+import { FixContext } from '../index.js';
+
+export type FixToConvertErrorToWarningPerFileArgs = {
+  description?: string;
+};
+
+function generateFix(context: FixContext, description?: string): Rule.Fix | null {
+  const ruleIdsToConverting = unique(
+    context.messages
+      // Ignore warnings
+      .filter((message) => message.severity === 2)
+      .map((message) => message.ruleId)
+      .filter(notEmpty),
+  );
+  if (ruleIdsToConverting.length === 0) return null;
+
+  const rulesRecordToConverting: Partial<Linter.RulesRecord> = Object.fromEntries(
+    ruleIdsToConverting.map((ruleId) => [ruleId, 1]),
+  );
+
+  // Insert the inline config comment at the top of the file.
+  // NOTE: Merging settings into an existing inline config comment is intentionally avoided
+  // because of the complexity of the implementation.
+
+  const text = toInlineConfigCommentText({ rulesRecord: rulesRecordToConverting, description }) + '\n';
+
+  const shebang = findShebang(context.sourceCode.text);
+  // if shebang exists, insert comment after shebang
+  return context.fixer.insertTextAfterRange(shebang?.range ?? [0, 0], text);
+}
+
+/**
+ * Create fix to convert error to warning per file.
+ */
+export function createFixToConvertErrorToWarningPerFile(
+  context: FixContext,
+  args: FixToConvertErrorToWarningPerFileArgs,
+): Rule.Fix[] {
+  const fix = generateFix(context, args.description);
+  return fix ? [fix] : [];
+}

package/src/plugin/fix/disable-per-line.ts

@@ -40,13 +40,24 @@ function generateFixPerLine(
     const headNode = context.sourceCode.getNodeByRangeIndex(headNodeIndex);
     if (headNode === null) return null; // For some reason, it seems to be null sometimes.
 
+    // Extract the same indent as the line we want to fix
+    const indent = context.sourceCode.text.slice(
+      headNodeIndex,
+      headNodeIndex +
+        context.sourceCode.text
+          .slice(headNodeIndex)
+          // ref: https://tc39.es/ecma262/#sec-white-space
+          // eslint-disable-next-line no-control-regex
+          .search(/[^\u{0009}\u{000B}\u{000C}\u{FEFF}\p{gc=Space_Separator}]/u),
+    );
+
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     if ((headNode.type as any) === 'JSXText') {
       const commentText = toCommentText({ type: 'Block', scope: 'next-line', ruleIds: ruleIdsToDisable, description });
-      return context.fixer.insertTextBeforeRange([headNodeIndex, headNodeIndex], '{' + commentText + '}\n');
+      return context.fixer.insertTextBeforeRange([headNodeIndex, headNodeIndex], indent + '{' + commentText + '}\n');
     } else {
       const commentText = toCommentText({ type: 'Line', scope: 'next-line', ruleIds: ruleIdsToDisable, description });
-      return context.fixer.insertTextBeforeRange([headNodeIndex, headNodeIndex], commentText + '\n');
+      return context.fixer.insertTextBeforeRange([headNodeIndex, headNodeIndex], indent + commentText + '\n');
     }
   }
 }

package/src/plugin/fix/index.ts

@@ -6,6 +6,10 @@ export {
 export { type FixToApplyAutoFixesArgs, createFixToApplyAutoFixes } from './apply-auto-fixes.js';
 export { type FixToDisablePerFileArgs, createFixToDisablePerFile } from './disable-per-file.js';
 export { type FixToDisablePerLineArgs, createFixToDisablePerLine } from './disable-per-line.js';
+export {
+  type FixToConvertErrorToWarningPerFileArgs,
+  createFixToConvertErrorToWarningPerFile,
+} from './convert-error-to-warning-per-file.js';
 export {
   type FixableMaker,
   type FixToMakeFixableAndFixArgs,

package/src/plugin/fix-rule.ts

@@ -2,6 +2,7 @@ import { ESLint, Rule } from 'eslint';
 import {
   createFixToApplyAutoFixes,
   createFixToApplySuggestions,
+  createFixToConvertErrorToWarningPerFile,
   createFixToDisablePerFile,
   createFixToDisablePerLine,
   createFixToMakeFixableAndFix,
@@ -53,6 +54,8 @@ function createFixes(context: Rule.RuleContext, ruleOption: FixRuleOption, fixer
     fixes = createFixToDisablePerLine(fixContext, fix.args);
   } else if (fix.name === 'disablePerFile') {
     fixes = createFixToDisablePerFile(fixContext, fix.args);
+  } else if (fix.name === 'convertErrorToWarningPerFile') {
+    fixes = createFixToConvertErrorToWarningPerFile(fixContext, fix.args);
   } else if (fix.name === 'applySuggestions') {
     fixes = createFixToApplySuggestions(fixContext, fix.args);
   } else if (fix.name === 'makeFixableAndFix') {

package/src/plugin/index.ts

@@ -8,6 +8,7 @@ import {
   type FixToDisablePerLineArgs,
   type FixToMakeFixableAndFixArgs,
   type FixToApplyAutoFixesArgs,
+  FixToConvertErrorToWarningPerFileArgs,
 } from './fix/index.js';
 import { preferAdditionShorthandRule } from './prefer-addition-shorthand-rule.js';
 
@@ -30,11 +31,18 @@ export type Fix =
   | { name: 'applyAutoFixes'; args: FixArg<'applyAutoFixes'> }
   | { name: 'disablePerLine'; args: FixArg<'disablePerLine'> }
   | { name: 'disablePerFile'; args: FixArg<'disablePerFile'> }
+  | { name: 'convertErrorToWarningPerFile'; args: FixArg<'convertErrorToWarningPerFile'> }
   | { name: 'applySuggestions'; args: FixArg<'applySuggestions'> }
   | { name: 'makeFixableAndFix'; args: FixArg<'makeFixableAndFix'> };
 
 /** For test */
-export type FixName = 'applyAutoFixes' | 'disablePerLine' | 'disablePerFile' | 'applySuggestions' | 'makeFixableAndFix';
+export type FixName =
+  | 'applyAutoFixes'
+  | 'disablePerLine'
+  | 'disablePerFile'
+  | 'convertErrorToWarningPerFile'
+  | 'applySuggestions'
+  | 'makeFixableAndFix';
 
 /** For test */
 export type FixArg<T extends FixName> = T extends 'applyAutoFixes'
@@ -43,6 +51,8 @@ export type FixArg<T extends FixName> = T extends 'applyAutoFixes'
   ? FixToDisablePerLineArgs
   : T extends 'disablePerFile'
   ? FixToDisablePerFileArgs
+  : T extends 'convertErrorToWarningPerFile'
+  ? FixToConvertErrorToWarningPerFileArgs
   : T extends 'applySuggestions'
   ? FixToApplySuggestionsArgs
   : T extends 'makeFixableAndFix'

package/src/scene/select-action.ts

@@ -2,6 +2,7 @@ import { Remote } from 'comlink';
 import { ESLint } from 'eslint';
 import {
   doApplySuggestionsAction,
+  doConvertErrorToWarningPerFileAction,
   doDisablePerFileAction,
   doDisablePerLineAction,
   doFixAction,
@@ -58,6 +59,9 @@ export async function selectAction(
   } else if (selectedAction === 'disablePerFile') {
     const undo = await doDisablePerFileAction(core, results, selectedRuleIds);
     return createCheckResultsScene(undo);
+  } else if (selectedAction === 'convertErrorToWarningPerFile') {
+    const undo = await doConvertErrorToWarningPerFileAction(core, results, selectedRuleIds);
+    return createCheckResultsScene(undo);
   } else if (selectedAction === 'applySuggestions') {
     const undo = await doApplySuggestionsAction(core, results, selectedRuleIds);
     return createCheckResultsScene(undo);

package/src/typings/cachedir.d.ts

@@ -1,5 +1,6 @@
 declare module 'cachedir' {
   // eslint-disable-next-line import/no-default-export
   function cachedir(name: string): string;
-  export = cachedir;
+  // eslint-disable-next-line import/no-default-export
+  export default cachedir;
 }

package/src/util/cache.ts

@@ -1,6 +1,5 @@
 import { join } from 'path';
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-import cachedir = require('cachedir');
+import cachedir from 'cachedir';
 import { VERSION } from '../cli/package.js';
 
 /**

package/src/util/eslint.ts

@@ -1,4 +1,4 @@
-import { AST, ESLint } from 'eslint';
+import { AST, ESLint, Linter } from 'eslint';
 import type { Comment } from 'estree';
 import { unique } from './array.js';
 import { notEmpty } from './type-check.js';
@@ -97,6 +97,30 @@ export function toCommentText({ type, scope, ruleIds, description }: Omit<Disabl
   }
 }
 
+export type InlineConfigComment = {
+  description?: string;
+  rulesRecord: Partial<Linter.RulesRecord>;
+  range: [number, number];
+};
+
+/**
+ * Convert `InlineConfigComment` to comment text.
+ */
+export function toInlineConfigCommentText({ rulesRecord, description }: Omit<InlineConfigComment, 'range'>): string {
+  const header = 'eslint';
+  const rulesRecordText = Object.entries(rulesRecord)
+    .map(([ruleId, ruleEntry]) => {
+      // TODO: Inherit options of the rule set by the user in eslintrc if the option exists.
+      return `${ruleId}: ${JSON.stringify(ruleEntry)}`;
+    })
+    .join(', ');
+  if (description === undefined) {
+    return `/* ${header} ${rulesRecordText} */`;
+  } else {
+    return `/* ${header} ${rulesRecordText} -- ${description} */`;
+  }
+}
+
 /**
  * Create the results with only messages with the specified rule ids.
  * @param results The lint results.