eslint-interactive 8.1.0

package/src/util/eslint.ts

@@ -0,0 +1,162 @@
+import { AST, ESLint } from 'eslint';
+import type { Comment } from 'estree';
+import { unique } from './array.js';
+import { notEmpty } from './type-check.js';
+
+const COMMENT_RE =
+  /^\s*(?<header>eslint-disable|eslint-disable-next-line)\s+(?<ruleList>[@a-z0-9\-_$/]*(?:\s*,\s*[@a-z0-9\-_$/]*)*(?:\s*,)?)(?:\s+--\s+(?<description>.*\S))?\s*$/u;
+
+const SHEBANG_PATTERN = /^#!.+?\r?\n/u;
+
+/** `results` 内で使われているプラグインの名前のリストを洗い出して返す */
+export function scanUsedPluginsFromResults(results: ESLint.LintResult[]): string[] {
+  const plugins = results
+    .flatMap((result) => result.messages) // messages: Linter.LintMessage[]
+    .map((message) => message.ruleId) // ruleIds: (string | undefined)[]
+    .filter(notEmpty) // ruleIds: string[]
+    .map((ruleId) => {
+      const parts = ruleId.split('/');
+      if (parts.length === 1) return undefined; // ex: 'rule-a'
+      if (parts.length === 2) return parts[0]; // ex: 'plugin/rule-a'
+      if (parts.length === 3) return `${parts[0]}/${parts[1]}`; // ex: '@scoped/plugin/rule-a'
+      return undefined; // invalid ruleId
+    }) // plugins: string[]
+    .filter(notEmpty);
+  return unique(plugins);
+}
+
+export type DisableComment = {
+  type: 'Block' | 'Line';
+  scope: 'next-line' | 'file';
+  ruleIds: string[];
+  description?: string;
+  range: [number, number];
+};
+
+/**
+ * コメントを ESLint の disable comment としてパースする。
+ * disable comment としてパースできなかった場合は undefined を返す。
+ *
+ * ## 参考: disable comment の構造
+ * /* eslint-disable-next-line rule-a, rule-b, rule-c, rule-d -- I'm the rules.
+ *    ^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^ ^^^^^^^^^^^^^^
+ *    |                        |                              |  |
+ *    header                   |                              |  |
+ *                             ruleList                       |  |
+ *                                            descriptionHeader  |
+ *                                                               description
+ */
+export function parseDisableComment(comment: Comment): DisableComment | undefined {
+  // NOTE: コメントノードには必ず range があるはずだが、型上は optional なので、
+  // range がない場合はパースに失敗した扱いにする。
+  if (!comment.range) return undefined;
+
+  const result = COMMENT_RE.exec(comment.value);
+  if (!result) return undefined;
+  if (!result.groups) return undefined;
+
+  const { header, ruleList, description } = result.groups;
+  const ruleIds = ruleList
+    .split(',')
+    .map((r) => r.trim())
+    // 空文字は除外しておく
+    .filter((ruleId) => ruleId !== '');
+
+  const scope = header === 'eslint-disable-next-line' ? 'next-line' : 'file';
+  // file scope comment must be block-style.
+  if (scope === 'file' && comment.type === 'Line') return undefined;
+
+  return {
+    type: comment.type,
+    scope: header === 'eslint-disable-next-line' ? 'next-line' : 'file',
+    ruleIds: ruleIds,
+    // description is optional
+    ...(description === '' || description === undefined ? {} : { description }),
+    range: comment.range,
+  };
+}
+
+/**
+ * Convert `DisableComment` to comment text.
+ */
+export function toCommentText({ type, scope, ruleIds, description }: Omit<DisableComment, 'range'>): string {
+  const header = scope === 'next-line' ? 'eslint-disable-next-line' : 'eslint-disable';
+  const ruleList = unique(ruleIds).join(', ');
+  if (type === 'Line') {
+    if (description === undefined) {
+      return `// ${header} ${ruleList}`;
+    } else {
+      return `// ${header} ${ruleList} -- ${description}`;
+    }
+  } else {
+    if (description === undefined) {
+      return `/* ${header} ${ruleList} */`;
+    } else {
+      return `/* ${header} ${ruleList} -- ${description} */`;
+    }
+  }
+}
+
+/**
+ * Create the results with only messages with the specified rule ids.
+ * @param results The lint results.
+ * @param ruleIds The rule ids.
+ * @returns The results with only messages with the specified rule ids
+ */
+export function filterResultsByRuleId(results: ESLint.LintResult[], ruleIds: (string | null)[]): ESLint.LintResult[] {
+  return results
+    .map((result) => {
+      return {
+        ...result,
+        messages: result.messages.filter((message) => ruleIds.includes(message.ruleId)),
+      };
+    })
+    .filter((result) => result.messages.length > 0);
+}
+
+/**
+ * push rule ids to the disable comment and return the new comment node.
+ * @param comment The comment node to be modified
+ * @param ruleIds The rule ids to be added
+ * @returns The new comment node
+ */
+export function pushRuleIdsToDisableComment(comment: DisableComment, ruleIds: string[]): DisableComment {
+  return {
+    ...comment,
+    ruleIds: unique([...comment.ruleIds, ...ruleIds]),
+  };
+}
+
+/**
+ * Merge the ruleIds and description of the disable comments.
+ * @param a The ruleIds and description of first disable comment
+ * @param b The ruleIds and description of second disable comment
+ * @returns The ruleIds and description of merged disable comment
+ */
+export function mergeRuleIdsAndDescription(
+  a: { ruleIds: string[]; description?: string },
+  b: { ruleIds: string[]; description?: string },
+): { ruleIds: string[]; description?: string } {
+  const ruleIds = unique([...a.ruleIds, ...b.ruleIds]);
+  const description =
+    a.description !== undefined && b.description !== undefined
+      ? `${a.description}, ${b.description}`
+      : a.description !== undefined && b.description === undefined
+      ? a.description
+      : a.description === undefined && b.description !== undefined
+      ? b.description
+      : undefined;
+  if (description === undefined) return { ruleIds };
+  return { ruleIds, description };
+}
+
+/**
+ * Find shebang from the first line of the file.
+ * @param sourceCodeText The source code text of the file.
+ * @returns The information of shebang. If the file does not have shebang, return null.
+ */
+export function findShebang(sourceCodeText: string): { range: AST.Range } | null {
+  const result = SHEBANG_PATTERN.exec(sourceCodeText);
+  if (!result) return null;
+  return { range: [0, result[0].length] };
+}

package/src/util/filter-script.ts

@@ -0,0 +1,45 @@
+import { exec as execOriginal } from 'child_process';
+import { mkdir, appendFile, readFile, access } from 'fs/promises';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { promisify } from 'util';
+import { getCacheDir } from './cache.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-]/g, '') + '.js';
+  const filepath = join(getCacheDir(), 'filter-script', basename);
+  return filepath;
+}
+
+export function generateFixableMakerScriptFilePath(ruleIds: string[]): string {
+  const basename = ruleIds.join('_').replace(/[^\w-]/g, '') + '.js';
+  const filepath = join(getCacheDir(), '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/src/util/type-check.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore next */
+export function unreachable(message?: string): never {
+  throw new Error(message ?? 'unreachable code');
+}
+
+export function notEmpty<TValue>(value: TValue | null | undefined): value is TValue {
+  return value !== null && value !== undefined;
+}

package/static/example-filter-script.js

@@ -0,0 +1,49 @@
+// @ts-check
+
+// Edit this file to customize how the suggestion is applied.
+// Save and close this file to apply the suggestion.
+//
+// NOTE(For VSCode user):
+// In the Restricted Mode of VSCode, the close event of the file is not notified to eslint-interactive.
+// Therefore, eslint-interactive will not start applying suggestions even if the file is closed, and eslint-interactive will freeze.
+// If you open a file in VSCode Restricted Mode, please follow the steps below:
+// 1. Trust the workspace
+// 2. Close the open file
+// 3. exit the frozen eslint-interactive with Ctrl+C
+// 4. Restart eslint-interactive and try to apply the suggestion again
+
+/**
+ * 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

@@ -0,0 +1,47 @@
+// @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`.
+//
+// NOTE(For VSCode user):
+// In the Restricted Mode of VSCode, the close event of the file is not notified to eslint-interactive.
+// Therefore, eslint-interactive will not start applying suggestions even if the file is closed, and eslint-interactive will freeze.
+// If you open a file in VSCode Restricted Mode, please follow the steps below:
+// 1. Trust the workspace
+// 2. Close the open file
+// 3. exit the frozen eslint-interactive with Ctrl+C
+// 4. Restart eslint-interactive and try to apply the suggestion again
+
+/**
+ * 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;