eslint-interactive 12.0.0 → 13.0.1

package/src/action/make-fixable-and-fix.ts

@@ -1,39 +0,0 @@
-import { access, mkdir, readFile, writeFile } from 'node:fs/promises';
-import { dirname } from 'node:path';
-import type { Remote } from 'comlink';
-import type { ESLint } from 'eslint';
-import { promptToInputReuseScript } from '../cli/prompt.js';
-import { fixingSpinner } from '../cli/spinner.js';
-import type { Undo } from '../core.js';
-import type { SerializableCore } from '../core-worker.js';
-import {
-  editFileWithEditor,
-  generateExampleFixableMakerScriptFilePath,
-  generateFixableMakerScriptFilePath,
-} from '../util/filter-script.js';
-
-export async function doMakeFixableAndFixAction(
-  core: Remote<SerializableCore>,
-  results: ESLint.LintResult[],
-  selectedRuleIds: string[],
-): Promise<Undo> {
-  const exampleScript = await readFile(generateExampleFixableMakerScriptFilePath(), 'utf8');
-  const fixableMakerScriptFilePath = generateFixableMakerScriptFilePath(selectedRuleIds);
-  const isFixableMakerScriptExist = await access(fixableMakerScriptFilePath)
-    .then(() => true)
-    .catch(() => false);
-  if (isFixableMakerScriptExist) {
-    const reuseScript = await promptToInputReuseScript();
-    if (!reuseScript) {
-      await writeFile(fixableMakerScriptFilePath, exampleScript);
-    }
-  } else {
-    await mkdir(dirname(fixableMakerScriptFilePath), { recursive: true }); // Create the directory because it might not exist
-    await writeFile(fixableMakerScriptFilePath, exampleScript);
-  }
-  console.log('Opening editor...');
-
-  const fixableMakerScript = await editFileWithEditor(fixableMakerScriptFilePath);
-  const undo = await fixingSpinner(async () => core.makeFixableAndFix(results, selectedRuleIds, fixableMakerScript));
-  return undo;
-}

package/src/config.ts

@@ -1,142 +0,0 @@
-import type { ESLint } from 'eslint';
-import type { ParsedCLIOptions } from './cli/parse-argv.js';
-import { cliOptionsDefaults } from './cli/parse-argv.js';
-import type { DeepPartial } from './util/type-check.js';
-
-type LegacyESLintOptions = { type: 'eslintrc' } & Pick<
-  ESLint.LegacyOptions,
-  | 'useEslintrc'
-  | 'overrideConfigFile'
-  | 'extensions'
-  | 'rulePaths'
-  | 'ignorePath'
-  | 'cache'
-  | 'cacheLocation'
-  | 'overrideConfig'
-  | 'cwd'
-  | 'resolvePluginsRelativeTo'
-  | 'plugins'
->;
-type FlatESLintOptions = { type: 'flat' } & Pick<
-  ESLint.Options,
-  'overrideConfigFile' | 'cache' | 'cacheLocation' | 'overrideConfig' | 'cwd' | 'flags'
->;
-
-export type ESLintOptions = LegacyESLintOptions | FlatESLintOptions;
-
-/** The config of eslint-interactive */
-export type Config = {
-  patterns: string[];
-  formatterName?: string | undefined;
-  quiet?: boolean | undefined;
-  cwd?: string | undefined;
-  eslintOptions: ESLintOptions;
-  flags?: string[] | undefined;
-};
-
-type ESLintOptionsType = 'eslintrc' | 'flat';
-
-export function translateCLIOptions(options: ParsedCLIOptions, eslintOptionsType: ESLintOptionsType): Config {
-  if (eslintOptionsType === 'eslintrc') {
-    return {
-      patterns: options.patterns,
-      formatterName: options.formatterName,
-      quiet: options.quiet,
-      eslintOptions: {
-        type: 'eslintrc',
-        useEslintrc: options.useEslintrc,
-        overrideConfigFile: options.overrideConfigFile,
-        extensions: options.extensions,
-        rulePaths: options.rulePaths,
-        ignorePath: options.ignorePath,
-        cache: options.cache,
-        cacheLocation: options.cacheLocation,
-        resolvePluginsRelativeTo: options.resolvePluginsRelativeTo,
-      },
-    };
-  } else if (eslintOptionsType === 'flat') {
-    return {
-      patterns: options.patterns,
-      formatterName: options.formatterName,
-      quiet: options.quiet,
-      eslintOptions: {
-        type: 'flat',
-        overrideConfigFile: options.overrideConfigFile,
-        cache: options.cache,
-        cacheLocation: options.cacheLocation,
-        // Pass flags conditionally to avoid errors in ESLint v8
-        ...(options.flags && options.flags.length > 0 ? { flags: options.flags } : {}),
-      },
-    };
-  } else {
-    throw new Error(`Unexpected configType: ${String(eslintOptionsType)}`);
-  }
-}
-
-/** Default config of `Core` */
-export const configDefaults = {
-  formatterName: cliOptionsDefaults.formatterName,
-  quiet: cliOptionsDefaults.quiet,
-  cwd: process.cwd(),
-  eslintOptions: {
-    useEslintrc: cliOptionsDefaults.useEslintrc,
-    overrideConfigFile: undefined,
-    extensions: undefined,
-    rulePaths: undefined,
-    ignorePath: undefined,
-    cache: cliOptionsDefaults.cache,
-    cacheLocation: undefined,
-    overrideConfig: undefined,
-    resolvePluginsRelativeTo: undefined,
-  },
-} satisfies DeepPartial<Config>;
-
-export type NormalizedConfig = {
-  patterns: string[];
-  formatterName: string;
-  quiet: boolean;
-  cwd: string;
-  eslintOptions: ESLintOptions;
-};
-
-export function normalizeConfig(config: Config): NormalizedConfig {
-  const cwd = config.cwd ?? configDefaults.cwd;
-  let eslintOptions: NormalizedConfig['eslintOptions'];
-  if (config.eslintOptions.type === 'eslintrc') {
-    eslintOptions = {
-      type: 'eslintrc',
-      useEslintrc: config.eslintOptions.useEslintrc ?? configDefaults.eslintOptions.useEslintrc,
-      overrideConfigFile: config.eslintOptions.overrideConfigFile ?? configDefaults.eslintOptions.overrideConfigFile,
-      extensions: config.eslintOptions.extensions ?? configDefaults.eslintOptions.extensions,
-      rulePaths: config.eslintOptions.rulePaths ?? configDefaults.eslintOptions.rulePaths,
-      ignorePath: config.eslintOptions.ignorePath ?? configDefaults.eslintOptions.ignorePath,
-      cache: config.eslintOptions.cache ?? configDefaults.eslintOptions.cache,
-      cacheLocation: config.eslintOptions.cacheLocation ?? configDefaults.eslintOptions.cacheLocation,
-      overrideConfig: config.eslintOptions.overrideConfig ?? configDefaults.eslintOptions.overrideConfig,
-      cwd,
-      resolvePluginsRelativeTo:
-        config.eslintOptions.resolvePluginsRelativeTo ?? configDefaults.eslintOptions.resolvePluginsRelativeTo,
-      plugins: config.eslintOptions.plugins,
-    };
-  } else {
-    eslintOptions = {
-      type: 'flat',
-      overrideConfigFile: config.eslintOptions.overrideConfigFile ?? configDefaults.eslintOptions.overrideConfigFile,
-      cache: config.eslintOptions.cache ?? configDefaults.eslintOptions.cache,
-      cacheLocation: config.eslintOptions.cacheLocation ?? configDefaults.eslintOptions.cacheLocation,
-      overrideConfig: config.eslintOptions.overrideConfig ?? configDefaults.eslintOptions.overrideConfig,
-      cwd,
-      // Pass flags conditionally to avoid errors in ESLint v8
-      ...(config.eslintOptions.flags && config.eslintOptions.flags.length > 0 ?
-        { flags: config.eslintOptions.flags }
-      : {}),
-    };
-  }
-  return {
-    patterns: config.patterns,
-    formatterName: config.formatterName ?? configDefaults.formatterName,
-    quiet: config.quiet ?? configDefaults.quiet,
-    cwd,
-    eslintOptions,
-  };
-}

package/src/eslint/use-at-your-own-risk.js

@@ -1,6 +0,0 @@
-// @ts-nocheck
-import eslintPkg from 'eslint/use-at-your-own-risk';
-
-export const LegacyESLint = eslintPkg.LegacyESLint;
-export const FlatESLint = eslintPkg.FlatESLint;
-export const shouldUseFlatConfig = eslintPkg.shouldUseFlatConfig;

package/src/util/file-system.ts

@@ -1,10 +0,0 @@
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { VERSION } from '../cli/package.js';
-
-/**
- * Get the path of the temporary directory for eslint-interactive.
- */
-export function getTempDir(): string {
-  return join(tmpdir(), 'eslint-interactive', VERSION);
-}

package/src/util/filter-script.ts

@@ -1,45 +0,0 @@
-import { exec as execOriginal } from 'node:child_process';
-import { access, appendFile, mkdir, readFile } from 'node:fs/promises';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { promisify } from 'node:util';
-import { getTempDir } from './file-system.js';
-
-const exec = promisify(execOriginal);
-
-const DEFAULT_EDITOR_COMMAND = 'vi';
-
-function getEditorCommand(): string {
-  return process.env['EDITOR'] ?? DEFAULT_EDITOR_COMMAND;
-}
-
-export async function editFileWithEditor(filepath: string): Promise<string> {
-  const command = getEditorCommand();
-  await mkdir(dirname(filepath), { recursive: true });
-  await access(filepath).catch(async () => {
-    await appendFile(filepath, '', 'utf8');
-  });
-  await exec(`${command} ${filepath}`);
-  const newContent = await readFile(filepath, 'utf8');
-  return newContent;
-}
-
-export function generateFilterScriptFilePath(ruleIds: string[]): string {
-  const basename = `${ruleIds.join('_').replace(/[^\w-]/gu, '')}.js`;
-  const filepath = join(getTempDir(), 'filter-script', basename);
-  return filepath;
-}
-
-export function generateFixableMakerScriptFilePath(ruleIds: string[]): string {
-  const basename = `${ruleIds.join('_').replace(/[^\w-]/gu, '')}.js`;
-  const filepath = join(getTempDir(), 'fixable-maker-script', basename);
-  return filepath;
-}
-
-export function generateExampleFilterScriptFilePath(): string {
-  return join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'static', 'example-filter-script.js');
-}
-
-export function generateExampleFixableMakerScriptFilePath(): string {
-  return join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'static', 'example-fixable-maker-script.js');
-}

package/static/example-filter-script.js

@@ -1,40 +0,0 @@
-// @ts-check
-
-// Edit this file to customize how the suggestion is applied.
-// Save and close this file to apply the suggestion.
-
-/**
- * A function that takes a list of suggestions that can be applied to a problem as arguments,
- * and selects the suggestion to be applied from the list and returns it.
- * @param {import('eslint').Linter.LintSuggestion[]} suggestions - The list of suggestions that can be applied to the problem
- * @param {import('eslint').Linter.LintMessage} message - The `message` that contained a `suggestion`
- * @param {import('eslint-interactive').FixContext} context - The context of the fix.
- * @returns {import('eslint').Linter.LintSuggestion | null | undefined} Suggestion to apply. If null or undefined is returned, do not apply any suggestion.
- */
-function filterSuggestions(suggestions, message, context) {
-  // example:
-
-  console.log(context.filename);
-
-  if (message.ruleId === 'no-unsafe-negation') {
-    return suggestions.find((suggestion) => suggestion.desc.startsWith('Wrap negation'));
-  } else if (message.ruleId === 'no-useless-escape') {
-    if (message.severity === 2) {
-      // error
-      // ref: https://github.com/eslint/eslint/blob/99b1fca0e61902f0d69aea4b4cdbf75d37ea20c4/lib/rules/no-useless-escape.js#L125
-      return suggestions.find((suggestion) => suggestion.messageId === 'removeEscape');
-    } else {
-      // warning
-      return suggestions.find((suggestion) => suggestion.messageId === 'escapeBackslash');
-    }
-  } else {
-    // apply first suggestion
-    // NOTE: `suggestion.length` must be greater than 0
-    return suggestions[0];
-  }
-}
-
-// Here, `filterSuggestions` is passed to eslint-interactive pass.
-// NOTE: The value evaluated on the last line of the file will be passed to eslint-interactive.
-// This is because eslint-interactive evaluates this file with `eval`.
-filterSuggestions;

package/static/example-fixable-maker-script.js

@@ -1,38 +0,0 @@
-// @ts-check
-
-// Edit this file to customize how  you want to convert `Linter.LintMessage` to `Rule.Fix`.
-// Save and close this file to run `eslint --fix`.
-
-/**
- * A function to convert `Linter.LintMessage` to `Rule.Fix`.
- * @param {import('eslint').Linter.LintMessage} message - The `Linter.LintMessage` to be converted.
- * @param {import('estree').Node | null} node - The node corresponding to the message.
- * @param {import('eslint-interactive').FixContext} context - The context of the fix.
- * @returns {import('eslint').Rule.Fix | null | undefined} The `Rule.Fix` converted from `Linter.LintMessage`. If null or undefined, the message is not fixable.
- */
-function fixableMaker(message, node, context) {
-  // example:
-
-  console.log(context.filename);
-
-  // Edge case handling
-  if (!node) return null;
-  if (!node.range) return null;
-
-  if (message.ruleId === 'no-unused-vars' || message.ruleId === '@typescript-eslint/no-unused-vars') {
-    // Add underscores to the head of unused variable names.
-    // target codes: https://astexplorer.net/#/gist/e33d44d2e69a733766abbc9706fd3ed5/169a615afba7b0d5c88e87894db93fc7346250d2
-
-    if (node.type !== 'Identifier') return null;
-    // For more information about the fixer API, see the following:
-    // https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes
-    return context.fixer.insertTextBefore(node, '_');
-  } else {
-    return null;
-  }
-}
-
-// Here, `fixableMaker` is passed to eslint-interactive pass.
-// NOTE: The value evaluated on the last line of the file will be passed to eslint-interactive.
-// This is because eslint-interactive evaluates this file with `eval`.
-fixableMaker;