@utoo/lint 0.1.4 → 0.2.1

package/README.md

@@ -41,6 +41,27 @@ Use machine-readable output:
 pnpm exec utoo-lint --format=json src
 ```
 
+## Autofix
+
+Apply safe fixes from all enabled rules that support autofix:
+
+```bash
+pnpm exec utoo-lint --fix src
+```
+
+Preview the result without changing files:
+
+```bash
+pnpm exec utoo-lint --fix-dry-run --format=json src
+```
+
+`--fix` writes fixed source back to disk. `--fix-dry-run` never writes files;
+with JSON output, changed sources are returned in the `outputs` array. Fixes run
+until the source is stable, subject to a safety pass limit. Diagnostics remain
+when a rule or a particular code shape cannot be fixed safely. The current
+[rule status](https://github.com/fireairforce/utoo-lint/blob/main/docs/rule-status.md)
+lists autofix coverage by rule.
+
 ## Configuration
 
 Create a `utoo.json` file:
@@ -97,6 +118,19 @@ manually.
 
 CommonJS is supported through `require("@utoo/lint")`.
 
+Set `fix: true` to compute fixed output through the JavaScript API. Raw
+`lintFiles()` and `lintText()` reports expose changed sources in `outputs`
+without writing them. The ESLint-compatible API follows the usual two-step
+flow:
+
+```js
+import { ESLint } from "@utoo/lint";
+
+const eslint = new ESLint({ fix: true });
+const results = await eslint.lintFiles(["src"]);
+await ESLint.outputFixes(results);
+```
+
 ## Binary Resolution
 
 `@utoo/lint` installs a platform-specific optional dependency containing the

package/index.cjs

@@ -417,6 +417,7 @@ const BUILTIN_RULE_IDS = [
   "@typescript-eslint/prefer-namespace-keyword",
   "@typescript-eslint/restrict-plus-operands"
 ];
+const FIXABLE_BUILTIN_RULE_IDS = new Set(["no-extra-semi", "@typescript-eslint/no-extra-semi"]);
 const BUILTIN_RULES = new Map(BUILTIN_RULE_IDS.map((ruleId) => [ruleId, createBuiltinRule(ruleId)]));
 
 class UtooLint {
@@ -882,12 +883,12 @@ function translateFishlintArgs(args = [], options = {}) {
       continue;
     }
     if (arg === "--fix") {
-      warn("utoo-lint: fishlint --fix is ignored because utoo-lint does not apply fixes yet.");
+      translated.push("--fix");
       index += 1;
       continue;
     }
     if (arg === "--fix-dry-run") {
-      warn("utoo-lint: fishlint --fix-dry-run is ignored because utoo-lint does not apply fixes yet.");
+      translated.push("--fix-dry-run");
       index += 1;
       continue;
     }
@@ -1067,6 +1068,7 @@ function lintFiles(paths, options = {}) {
     if (!resolvedOptions.deferDiagnosticConfigFiltering) {
       report.filePaths = normalizeReportFilePaths(report.filePaths, resolvedOptions);
       report.diagnostics = normalizeDiagnosticFilePaths(report.diagnostics, resolvedOptions);
+      report.outputs = normalizeReportOutputs(report.outputs, resolvedOptions);
       report.diagnostics = normalizeReportDiagnostics(report.diagnostics, resolvedOptions);
       report.exitCode = exitCodeForDiagnostics(report.diagnostics);
     }
@@ -1115,6 +1117,10 @@ function lintText(code, options = {}) {
       deferDiagnosticConfigFiltering: true
     });
     report.filePaths = (report.filePaths ?? []).map((filePath) => (filePath === tempFile ? requestedPath : filePath));
+    report.outputs = (report.outputs ?? []).map((fixed) => ({
+      ...fixed,
+      filePath: fixed.filePath === tempFile ? requestedPath : fixed.filePath
+    }));
     report.diagnostics = report.diagnostics.map((diagnostic) => ({
       ...diagnostic,
       filePath: requestedPath
@@ -1165,6 +1171,10 @@ function buildNativeLintArgs(paths, options) {
     cliArgs.push(`--format=${options.format}`);
   }
 
+  if (options.fix) {
+    cliArgs.push("--fix-dry-run");
+  }
+
   if (options.extraArgs) {
     cliArgs.push(...normalizeStringArray(options.extraArgs, "extraArgs"));
   }
@@ -1882,7 +1892,9 @@ function appendCustomLintTextMessages(results, code, filePath, config, rules, op
   if (customRules.length === 0) {
     return results;
   }
-  const sourceCode = createLinterSourceCode(code);
+  let result = results.find((item) => item.filePath === filePath);
+  const effectiveCode = typeof result?.output === "string" ? result.output : code;
+  const sourceCode = createLinterSourceCode(effectiveCode);
   const messages = runCustomLinterRules(customRules, sourceCode, {
     cwd: options.cwd,
     filename: filePath,
@@ -1893,14 +1905,13 @@ function appendCustomLintTextMessages(results, code, filePath, config, rules, op
     return results;
   }
 
-  let result = results.find((item) => item.filePath === filePath);
   if (!result) {
-    result = emptyESLintResult(filePath, code);
+    result = emptyESLintResult(filePath, effectiveCode);
     results.push(result);
   }
   result.messages.push(...filtered.messages);
   result.suppressedMessages.push(...filtered.suppressedMessages);
-  applyResultFixes(result, code, options);
+  applyResultFixes(result, effectiveCode, options);
   finalizeESLintResult(result);
   return results;
 }
@@ -1913,11 +1924,13 @@ function appendCustomLintFileMessages(results, config, options) {
     if (customRules.length === 0) {
       continue;
     }
-    let code;
-    try {
-      code = readFileSync(filePath, "utf8");
-    } catch {
-      continue;
+    let code = result.output;
+    if (typeof code !== "string") {
+      try {
+        code = readFileSync(filePath, "utf8");
+      } catch {
+        continue;
+      }
     }
     const sourceCode = createLinterSourceCode(code);
     const messages = runCustomLinterRules(customRules, sourceCode, {
@@ -3471,6 +3484,14 @@ function reportToESLintResults(report, textOptions = {}) {
     byFile.get(filePath).messages.push(diagnosticToESLintMessage(diagnostic, ruleSeverities));
   }
 
+  for (const fixed of report.outputs ?? []) {
+    const filePath = textOptions.filePath ?? normalizeESLintFilePath(fixed.filePath, textOptions.cwd);
+    if (!byFile.has(filePath)) {
+      byFile.set(filePath, emptyESLintResult(filePath, textOptions.source));
+    }
+    byFile.get(filePath).output = fixed.output;
+  }
+
   if (textOptions.filePath && textOptions.includeEmptyTextResult !== false && !byFile.has(textOptions.filePath)) {
     byFile.set(textOptions.filePath, emptyESLintResult(textOptions.filePath, textOptions.source));
   }
@@ -3517,6 +3538,13 @@ function normalizeReportFilePaths(filePaths, options = {}) {
   return (filePaths ?? []).map((filePath) => normalizeESLintFilePath(filePath, options.cwd));
 }
 
+function normalizeReportOutputs(outputs, options = {}) {
+  return (outputs ?? []).map((fixed) => ({
+    ...fixed,
+    filePath: normalizeESLintFilePath(fixed.filePath, options.cwd)
+  }));
+}
+
 function normalizeDiagnosticFilePaths(diagnostics, options = {}) {
   return (diagnostics ?? []).map((diagnostic) => ({
     ...diagnostic,
@@ -4035,11 +4063,15 @@ function getErrorResults(results) {
 }
 
 function ruleMetaForRuleId(ruleId) {
-  return {
+  const meta = {
     docs: {
       url: ruleDocsUrl(ruleId)
     }
   };
+  if (FIXABLE_BUILTIN_RULE_IDS.has(ruleId)) {
+    meta.fixable = "code";
+  }
+  return meta;
 }
 
 function createBuiltinRule(ruleId) {
@@ -4114,7 +4146,7 @@ function emptyESLintResult(filePath, source) {
 }
 
 function diagnosticToESLintMessage(diagnostic, ruleSeverities) {
-  return {
+  const message = {
     ruleId: diagnostic.ruleId,
     severity: ruleSeverities?.get(diagnostic.ruleId) ?? (diagnostic.severity === "error" ? 2 : 1),
     message: diagnostic.message,
@@ -4122,6 +4154,14 @@ function diagnosticToESLintMessage(diagnostic, ruleSeverities) {
     column: diagnostic.column,
     nodeType: null
   };
+  const fixes = (diagnostic.fixes ?? []).map((fix) => ({
+    range: fix.range,
+    text: fix.text
+  }));
+  if (fixes.length > 0) {
+    message.fix = fixes.length === 1 ? fixes[0] : fixes;
+  }
+  return message;
 }
 
 function finalizeESLintResult(result) {

package/index.d.ts

@@ -38,6 +38,7 @@ export interface LintReport {
   files: number;
   filePaths: string[];
   diagnostics: LintMessage[];
+  outputs?: Array<{ filePath: string; output: string }>;
   exitCode: number;
   stderr?: string;
 }

package/index.js

@@ -420,6 +420,7 @@ const BUILTIN_RULE_IDS = [
   "@typescript-eslint/prefer-namespace-keyword",
   "@typescript-eslint/restrict-plus-operands"
 ];
+const FIXABLE_BUILTIN_RULE_IDS = new Set(["no-extra-semi", "@typescript-eslint/no-extra-semi"]);
 const BUILTIN_RULES = new Map(BUILTIN_RULE_IDS.map((ruleId) => [ruleId, createBuiltinRule(ruleId)]));
 
 export class UtooLint {
@@ -832,7 +833,9 @@ function appendCustomLintTextMessages(results, code, filePath, config, rules, op
   if (customRules.length === 0) {
     return results;
   }
-  const sourceCode = createLinterSourceCode(code);
+  let result = results.find((item) => item.filePath === filePath);
+  const effectiveCode = typeof result?.output === "string" ? result.output : code;
+  const sourceCode = createLinterSourceCode(effectiveCode);
   const messages = runCustomLinterRules(customRules, sourceCode, {
     cwd: options.cwd,
     filename: filePath,
@@ -843,14 +846,13 @@ function appendCustomLintTextMessages(results, code, filePath, config, rules, op
     return results;
   }
 
-  let result = results.find((item) => item.filePath === filePath);
   if (!result) {
-    result = emptyESLintResult(filePath, code);
+    result = emptyESLintResult(filePath, effectiveCode);
     results.push(result);
   }
   result.messages.push(...filtered.messages);
   result.suppressedMessages.push(...filtered.suppressedMessages);
-  applyResultFixes(result, code, options);
+  applyResultFixes(result, effectiveCode, options);
   finalizeESLintResult(result);
   return results;
 }
@@ -863,11 +865,13 @@ function appendCustomLintFileMessages(results, config, options) {
     if (customRules.length === 0) {
       continue;
     }
-    let code;
-    try {
-      code = readFileSync(filePath, "utf8");
-    } catch {
-      continue;
+    let code = result.output;
+    if (typeof code !== "string") {
+      try {
+        code = readFileSync(filePath, "utf8");
+      } catch {
+        continue;
+      }
     }
     const sourceCode = createLinterSourceCode(code);
     const messages = runCustomLinterRules(customRules, sourceCode, {
@@ -2715,12 +2719,12 @@ export function translateFishlintArgs(args = [], options = {}) {
       continue;
     }
     if (arg === "--fix") {
-      warn("utoo-lint: fishlint --fix is ignored because utoo-lint does not apply fixes yet.");
+      translated.push("--fix");
       index += 1;
       continue;
     }
     if (arg === "--fix-dry-run") {
-      warn("utoo-lint: fishlint --fix-dry-run is ignored because utoo-lint does not apply fixes yet.");
+      translated.push("--fix-dry-run");
       index += 1;
       continue;
     }
@@ -2900,6 +2904,7 @@ export function lintFiles(paths, options = {}) {
     if (!resolvedOptions.deferDiagnosticConfigFiltering) {
       report.filePaths = normalizeReportFilePaths(report.filePaths, resolvedOptions);
       report.diagnostics = normalizeDiagnosticFilePaths(report.diagnostics, resolvedOptions);
+      report.outputs = normalizeReportOutputs(report.outputs, resolvedOptions);
       report.diagnostics = normalizeReportDiagnostics(report.diagnostics, resolvedOptions);
       report.exitCode = exitCodeForDiagnostics(report.diagnostics);
     }
@@ -2948,6 +2953,10 @@ export function lintText(code, options = {}) {
       deferDiagnosticConfigFiltering: true
     });
     report.filePaths = (report.filePaths ?? []).map((filePath) => (filePath === tempFile ? requestedPath : filePath));
+    report.outputs = (report.outputs ?? []).map((fixed) => ({
+      ...fixed,
+      filePath: fixed.filePath === tempFile ? requestedPath : fixed.filePath
+    }));
     report.diagnostics = report.diagnostics.map((diagnostic) => ({
       ...diagnostic,
       filePath: requestedPath
@@ -2998,6 +3007,10 @@ function buildNativeLintArgs(paths, options) {
     cliArgs.push(`--format=${options.format}`);
   }
 
+  if (options.fix) {
+    cliArgs.push("--fix-dry-run");
+  }
+
   if (options.extraArgs) {
     cliArgs.push(...normalizeStringArray(options.extraArgs, "extraArgs"));
   }
@@ -3474,6 +3487,14 @@ function reportToESLintResults(report, textOptions = {}) {
     byFile.get(filePath).messages.push(diagnosticToESLintMessage(diagnostic, ruleSeverities));
   }
 
+  for (const fixed of report.outputs ?? []) {
+    const filePath = textOptions.filePath ?? normalizeESLintFilePath(fixed.filePath, textOptions.cwd);
+    if (!byFile.has(filePath)) {
+      byFile.set(filePath, emptyESLintResult(filePath, textOptions.source));
+    }
+    byFile.get(filePath).output = fixed.output;
+  }
+
   if (textOptions.filePath && textOptions.includeEmptyTextResult !== false && !byFile.has(textOptions.filePath)) {
     byFile.set(textOptions.filePath, emptyESLintResult(textOptions.filePath, textOptions.source));
   }
@@ -3520,6 +3541,13 @@ function normalizeReportFilePaths(filePaths, options = {}) {
   return (filePaths ?? []).map((filePath) => normalizeESLintFilePath(filePath, options.cwd));
 }
 
+function normalizeReportOutputs(outputs, options = {}) {
+  return (outputs ?? []).map((fixed) => ({
+    ...fixed,
+    filePath: normalizeESLintFilePath(fixed.filePath, options.cwd)
+  }));
+}
+
 function normalizeDiagnosticFilePaths(diagnostics, options = {}) {
   return (diagnostics ?? []).map((diagnostic) => ({
     ...diagnostic,
@@ -4038,11 +4066,15 @@ function getErrorResults(results) {
 }
 
 function ruleMetaForRuleId(ruleId) {
-  return {
+  const meta = {
     docs: {
       url: ruleDocsUrl(ruleId)
     }
   };
+  if (FIXABLE_BUILTIN_RULE_IDS.has(ruleId)) {
+    meta.fixable = "code";
+  }
+  return meta;
 }
 
 function createBuiltinRule(ruleId) {
@@ -4117,7 +4149,7 @@ function emptyESLintResult(filePath, source) {
 }
 
 function diagnosticToESLintMessage(diagnostic, ruleSeverities) {
-  return {
+  const message = {
     ruleId: diagnostic.ruleId,
     severity: ruleSeverities?.get(diagnostic.ruleId) ?? (diagnostic.severity === "error" ? 2 : 1),
     message: diagnostic.message,
@@ -4125,6 +4157,14 @@ function diagnosticToESLintMessage(diagnostic, ruleSeverities) {
     column: diagnostic.column,
     nodeType: null
   };
+  const fixes = (diagnostic.fixes ?? []).map((fix) => ({
+    range: fix.range,
+    text: fix.text
+  }));
+  if (fixes.length > 0) {
+    message.fix = fixes.length === 1 ? fixes[0] : fixes;
+  }
+  return message;
 }
 
 function finalizeESLintResult(result) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utoo/lint",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "Experimental JavaScript and TypeScript linter powered by Yuku",
   "license": "MIT",
   "repository": {
@@ -70,11 +70,11 @@
     "use-at-your-own-risk.js"
   ],
   "optionalDependencies": {
-    "@utoo/lint-darwin-arm64": "0.1.4",
-    "@utoo/lint-darwin-x64": "0.1.4",
-    "@utoo/lint-linux-arm64": "0.1.4",
-    "@utoo/lint-linux-x64": "0.1.4",
-    "@utoo/lint-win32-x64": "0.1.4"
+    "@utoo/lint-darwin-arm64": "0.2.1",
+    "@utoo/lint-darwin-x64": "0.2.1",
+    "@utoo/lint-linux-arm64": "0.2.1",
+    "@utoo/lint-linux-x64": "0.2.1",
+    "@utoo/lint-win32-x64": "0.2.1"
   },
   "publishConfig": {
     "access": "public",