@utoo/lint 0.3.7 → 0.3.8

package/README.md

@@ -244,6 +244,20 @@ const results = await eslint.lintFiles(["src"]);
 await ESLint.outputFixes(results);
 ```
 
+`await eslint.loadFormatter()` and `cliEngine.getFormatter()` default to an
+ESLint-style `stylish` report: aligned columns, blank lines between files,
+diagnostics sorted by line and column, and a summary of fixable errors and
+warnings. Rule messages (including punctuation), result arrays, and exit codes
+are unchanged. Only actual autofixes count toward the `--fix` hint, not editor
+suggestions; missing JSX keys still need a manually chosen stable, unique key.
+
+The stylish formatter detects color support on stdout. Pass `color: true` or
+`color: false` to the `ESLint` or `CLIEngine` constructor to override detection.
+Otherwise, `NO_COLOR` or `NODE_DISABLE_COLORS` disables color; `FORCE_COLOR`
+forces it (`0` disables), followed by `CLICOLOR_FORCE` and stdout TTY detection
+(`TERM=dumb` disables automatic color). Constructor `env` overrides also apply.
+JSON, JSON-with-metadata, compact, unix, and native CLI text formats are unchanged.
+
 Raw reports include active diagnostics, suppressed diagnostics, fixed outputs,
 and an exit code. The compatibility layer also exports `Linter`, `CLIEngine`,
 `RuleTester`, and `SourceCode` APIs.

package/index.cjs

@@ -6,6 +6,7 @@ const { dirname, extname, isAbsolute, join, relative, resolve: resolvePath } = r
 
 const { platformPackageName, resolveBinary } = require("./lib/binary.cjs");
 const { createLegacyConfigResolver } = require("./lib/legacy-config.cjs");
+const { formatESLintResults } = require("./lib/stylish-formatter.cjs");
 const {
   findConfigPath: findConfigPathFromDirectory,
   readConfig
@@ -626,7 +627,7 @@ class UtooLint {
       format(results) {
         return formatResultsByName(results, name, {
           rulesMeta: (results) => eslint.getRulesMetaForResults(results)
-        });
+        }, eslint.options);
       }
     };
   }
@@ -704,7 +705,7 @@ class CLIEngine {
 
   getFormatter(name = "stylish") {
     return (results) => {
-      return formatResultsByName(results, name);
+      return formatResultsByName(results, name, {}, this.options);
     };
   }
 
@@ -5004,31 +5005,7 @@ function maybeFilterQuietResults(results, options = {}) {
   return results;
 }
 
-function formatESLintResults(results) {
-  const lines = [];
-  let errorCount = 0;
-  let warningCount = 0;
-
-  for (const result of results) {
-    if (result.messages.length === 0) continue;
-    lines.push(result.filePath);
-    for (const message of result.messages) {
-      const severity = message.severity === 2 ? "error" : "warning";
-      lines.push(`  ${message.line}:${message.column}  ${severity}  ${message.message}  ${message.ruleId}`);
-    }
-    errorCount += result.errorCount;
-    warningCount += result.warningCount;
-  }
-
-  if (errorCount || warningCount) {
-    lines.push("");
-    lines.push(`x ${errorCount + warningCount} problem${errorCount + warningCount === 1 ? "" : "s"} (${errorCount} error${errorCount === 1 ? "" : "s"}, ${warningCount} warning${warningCount === 1 ? "" : "s"})`);
-  }
-
-  return lines.join("\n");
-}
-
-function formatResultsByName(input, name = "stylish", metadata = {}) {
+function formatResultsByName(input, name = "stylish", metadata = {}, options = {}) {
   const results = formatterResults(input);
   if (name === "json") {
     return JSON.stringify(input);
@@ -5047,7 +5024,7 @@ function formatResultsByName(input, name = "stylish", metadata = {}) {
   if (name === "unix") {
     return formatUnixResults(results);
   }
-  return formatESLintResults(results);
+  return formatESLintResults(results, options);
 }
 
 function formatterResults(input) {

package/index.js

@@ -7,6 +7,7 @@ import { fileURLToPath } from "node:url";
 
 import { resolveBinary } from "./lib/binary.js";
 import { createLegacyConfigResolver } from "./lib/legacy-config.cjs";
+import { formatESLintResults } from "./lib/stylish-formatter.cjs";
 import {
   findConfigPath as findConfigPathFromDirectory,
   readConfig
@@ -629,7 +630,7 @@ export class UtooLint {
       format(results) {
         return formatResultsByName(results, name, {
           rulesMeta: (results) => eslint.getRulesMetaForResults(results)
-        });
+        }, eslint.options);
       }
     };
   }
@@ -2603,7 +2604,7 @@ export class CLIEngine {
 
   getFormatter(name = "stylish") {
     return (results) => {
-      return formatResultsByName(results, name);
+      return formatResultsByName(results, name, {}, this.options);
     };
   }
 
@@ -5007,31 +5008,7 @@ function maybeFilterQuietResults(results, options = {}) {
   return results;
 }
 
-function formatESLintResults(results) {
-  const lines = [];
-  let errorCount = 0;
-  let warningCount = 0;
-
-  for (const result of results) {
-    if (result.messages.length === 0) continue;
-    lines.push(result.filePath);
-    for (const message of result.messages) {
-      const severity = message.severity === 2 ? "error" : "warning";
-      lines.push(`  ${message.line}:${message.column}  ${severity}  ${message.message}  ${message.ruleId}`);
-    }
-    errorCount += result.errorCount;
-    warningCount += result.warningCount;
-  }
-
-  if (errorCount || warningCount) {
-    lines.push("");
-    lines.push(`x ${errorCount + warningCount} problem${errorCount + warningCount === 1 ? "" : "s"} (${errorCount} error${errorCount === 1 ? "" : "s"}, ${warningCount} warning${warningCount === 1 ? "" : "s"})`);
-  }
-
-  return lines.join("\n");
-}
-
-function formatResultsByName(input, name = "stylish", metadata = {}) {
+function formatResultsByName(input, name = "stylish", metadata = {}, options = {}) {
   const results = formatterResults(input);
   if (name === "json") {
     return JSON.stringify(input);
@@ -5050,7 +5027,7 @@ function formatResultsByName(input, name = "stylish", metadata = {}) {
   if (name === "unix") {
     return formatUnixResults(results);
   }
-  return formatESLintResults(results);
+  return formatESLintResults(results, options);
 }
 
 function formatterResults(input) {

package/lib/stylish-formatter.cjs

@@ -0,0 +1,79 @@
+const { stripVTControlCharacters } = require("node:util");
+
+function formatESLintResults(results, options = {}) {
+  const color = shouldUseColor(options);
+  const paint = (text, open, close) => color ? `\u001b[${open}m${text}\u001b[${close}m` : text;
+  const lines = [""];
+  let errorCount = 0;
+  let warningCount = 0;
+  let fixableErrorCount = 0;
+  let fixableWarningCount = 0;
+
+  for (const result of results) {
+    if (result.messages.length === 0) continue;
+    lines.push(paint(result.filePath, 4, 24));
+    // Sort a copy: formatting must not reorder the caller's results or JSON output.
+    const messages = [...result.messages].sort((left, right) =>
+      (left.line ?? 0) - (right.line ?? 0) || (left.column ?? 0) - (right.column ?? 0)
+    );
+    const rows = messages.map((message) => [
+      String(message.line || 0),
+      String(message.column || 0),
+      message.fatal || message.severity === 2 ? "error" : "warning",
+      // Unlike ESLint stylish, retain punctuation in the original rule message.
+      message.message,
+      message.ruleId || "",
+    ]);
+    const widths = [0, 0, 0, 0];
+    for (const row of rows) {
+      for (let index = 0; index < widths.length; index += 1) {
+        widths[index] = Math.max(widths[index], stripVTControlCharacters(row[index]).length);
+      }
+    }
+    for (const [line, column, severity, message, ruleId] of rows) {
+      const location = " ".repeat(widths[0] - line.length)
+        + paint(`${line}:${column}`, 2, 22)
+        + " ".repeat(widths[1] - column.length);
+      const label = paint(severity, severity === "error" ? 31 : 33, 39)
+        + " ".repeat(widths[2] - severity.length);
+      const padding = " ".repeat(widths[3] - stripVTControlCharacters(message).length);
+      const description = ruleId ? `${message}${padding}  ${paint(ruleId, 2, 22)}` : message;
+      lines.push(`  ${location}  ${label}  ${description}`);
+    }
+    lines.push("");
+    errorCount += result.errorCount;
+    warningCount += result.warningCount;
+    fixableErrorCount += result.fixableErrorCount ?? 0;
+    fixableWarningCount += result.fixableWarningCount ?? 0;
+  }
+
+  if (errorCount || warningCount) {
+    const summary = (text) => paint(paint(text, 1, 22), errorCount ? 31 : 33, 39);
+    lines.push(summary(
+      `✖ ${pluralize(errorCount + warningCount, "problem")} (${pluralize(errorCount, "error")}, ${pluralize(warningCount, "warning")})`
+    ));
+    if (fixableErrorCount || fixableWarningCount) {
+      lines.push(summary(
+        `  ${pluralize(fixableErrorCount, "error")} and ${pluralize(fixableWarningCount, "warning")} potentially fixable with the \`--fix\` option.`
+      ));
+    }
+    lines.push("");
+  }
+
+  return lines.join("\n");
+}
+
+function pluralize(count, noun) {
+  return `${count} ${noun}${count === 1 ? "" : "s"}`;
+}
+
+function shouldUseColor(options) {
+  if (typeof options.color === "boolean") return options.color;
+  const env = options.env ? { ...process.env, ...options.env } : process.env;
+  if (env.NO_COLOR !== undefined || env.NODE_DISABLE_COLORS !== undefined) return false;
+  if (env.FORCE_COLOR !== undefined) return env.FORCE_COLOR !== "0";
+  if (env.CLICOLOR_FORCE && env.CLICOLOR_FORCE !== "0") return true;
+  return env.TERM !== "dumb" && Boolean(process.stdout.isTTY);
+}
+
+module.exports = { formatESLintResults };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utoo/lint",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "High-performance JavaScript and TypeScript linter powered by Yuku",
   "license": "MIT",
   "repository": {
@@ -76,11 +76,11 @@
     "use-at-your-own-risk.js"
   ],
   "optionalDependencies": {
-    "@utoo/lint-darwin-arm64": "0.3.7",
-    "@utoo/lint-darwin-x64": "0.3.7",
-    "@utoo/lint-linux-arm64": "0.3.7",
-    "@utoo/lint-linux-x64": "0.3.7",
-    "@utoo/lint-win32-x64": "0.3.7"
+    "@utoo/lint-darwin-arm64": "0.3.8",
+    "@utoo/lint-darwin-x64": "0.3.8",
+    "@utoo/lint-linux-arm64": "0.3.8",
+    "@utoo/lint-linux-x64": "0.3.8",
+    "@utoo/lint-win32-x64": "0.3.8"
   },
   "dependencies": {
     "@eslint/eslintrc": "2.1.4",