eslint-interactive 9.0.0 → 10.0.0

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,
@@ -56,6 +55,7 @@ export type Config = {
   rulePaths?: string[] | undefined;
   extensions?: string[] | undefined;
   formatterName?: string;
+  quiet?: boolean;
   cache?: boolean;
   cacheLocation?: string;
   cwd?: string;
@@ -66,6 +66,7 @@ export const DEFAULT_BASE_CONFIG = {
   cache: true,
   cacheLocation: join(getCacheDir(), '.eslintcache'),
   formatterName: 'codeframe',
+  quiet: false,
 };
 
 /**
@@ -94,7 +95,8 @@ export class Core {
    */
   async lint(): Promise<ESLint.LintResult[]> {
     const eslint = new ESLint(this.baseOptions);
-    const results = await eslint.lintFiles(this.config.patterns);
+    let results = await eslint.lintFiles(this.config.patterns);
+    if (this.config.quiet) results = ESLint.getErrorResults(results);
     return results;
   }
 
@@ -173,6 +175,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

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/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.