@darksheep/eslint-formatter-github 0.0.0 → 0.1.0

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "@darksheep/eslint-formatter-github",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "ESLint + Github actions",
   "license": "UNLICENCED",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./types/index.d.ts",
   "files": [
-    "./src"
+    "./src",
+    "./types"
   ],
   "scripts": {
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "prepack": "tsc"
   },
   "dependencies": {
     "@darksheep/github-actions": "~0.0.0",
     "@darksheep/package.json": "~0.0.1"
   },
   "devDependencies": {
-    "@darksheep/eslint": "~4.3.0",
+    "@darksheep/eslint": "~4.4.0",
     "@types/node": "~20.12.0",
     "eslint": "~8.57.0",
     "typescript": "~5.4.0"

package/src/index.js

@@ -40,65 +40,96 @@ const {
  * @property {number} fixableWarningCount
  */
 
+/**
+ * @param {LintResult[]} fileResults The eslint results
+ * @returns {Record<'warningCount' | 'errorCount', number>}
+ */
+function counters(fileResults) {
+  let warningCount = 0;
+  let errorCount = 0;
+
+  for (const fileResult of fileResults) {
+    warningCount += fileResult.warningCount;
+    errorCount += fileResult.errorCount;
+  }
+
+  return {
+    warningCount,
+    errorCount,
+  };
+}
+
+/**
+ * @param {LintResult} fileResult The eslint single file result
+ * @returns {string[]}
+ */
+function formatFileResult(fileResult) {
+  /** @type {string[]} */
+  const lines = [];
+  const filePath = path.relative(
+    GITHUB_WORKSPACE,
+    fileResult.filePath,
+  );
+
+  for (const result of fileResult.messages) {
+    const message = result.ruleId == null || result.ruleId === ''
+      ? `[${result.ruleId}] ${result.message}`
+      : result.message;
+
+    /** @type {import('@darksheep/github-actions').LineAnnotation} */
+    const context = {
+      file: filePath,
+      line: result.line,
+      col: result.column,
+      endLine: result.endLine,
+      endColumn: result.endColumn,
+    };
+
+    switch (result.severity) {
+      /* eslint-disable style/max-statements-per-line */
+      case 0: lines.push(setNotice(message, context)); break;
+      case 1: lines.push(setWarning(message, context)); break;
+      case 2: lines.push(setError(message, context)); break;
+      /* eslint-enable style/max-statements-per-line */
+    }
+  }
+
+  return lines;
+}
+
 /**
  * @param {LintResult[]} fileResults The eslint results
  * @returns {string}
  */
 function formatter(fileResults) {
   const lines = [];
-  let warningCount = 0;
-  let errorCount = 0;
 
   const pkg = getPackageJson(undefined, `${process.cwd()}/package.json`);
   if (pkg == null) {
     throw new Error('Cannot resolve package name');
   }
 
-  lines.push(startGroup(`Linting ${pkg.name}`));
+  const { warningCount, errorCount } = counters(fileResults);
 
-  for (const fileResult of fileResults) {
-    const filePath = path.relative(
-      GITHUB_WORKSPACE,
-      fileResult.filePath,
-    );
+  if (warningCount + errorCount > 0) {
+    lines.push(startGroup([
+      `Linted ${pkg.name} (`,
+      `${errorCount} ${plural('error', errorCount)}, `,
+      `${warningCount} ${plural('warning', warningCount)})`,
+    ].join('')));
+  } else {
+    lines.push(`Linted ${pkg.name} (0 errors, 0 warnings)`);
+  }
 
-    warningCount += fileResult.warningCount;
-    errorCount += fileResult.errorCount;
+  lines.push(...fileResults.flatMap(formatFileResult));
 
-    for (const result of fileResult.messages) {
-      const message = result.ruleId == null || result.ruleId === ''
-        ? `[${result.ruleId}] ${result.message}`
-        : result.message;
-
-      /** @type {import('@darksheep/github-actions').LineAnnotation} */
-      const context = {
-        file: filePath,
-        line: result.line,
-        col: result.column,
-        endLine: result.endLine,
-        endColumn: result.endColumn,
-      };
-
-      switch (result.severity) {
-        case 0:
-          lines.push(setNotice(message, context));
-          break;
-        case 1:
-          lines.push(setWarning(message, context));
-          break;
-        case 2:
-          lines.push(setError(message, context));
-          break;
-      }
-    }
+  if (warningCount + errorCount > 0) {
+    lines.push(endGroup());
   }
 
-  lines.push(endGroup());
-
-  const total = errorCount + warningCount;
-  process.exitCode = errorCount;
+  process.exitCode ??= 0;
+  process.exitCode += errorCount;
 
-  lines.push(`${total} problem(s) (${errorCount} ${plural('error', errorCount)}, ${warningCount} ${plural('warning', warningCount)})`);
   return lines.join('\n');
 }
 

package/types/index.d.ts

@@ -0,0 +1,30 @@
+export = formatter;
+/**
+ * @param {LintResult[]} fileResults The eslint results
+ * @returns {string}
+ */
+declare function formatter(fileResults: LintResult[]): string;
+declare namespace formatter {
+    export { LintMessage, LintResult };
+}
+type LintResult = {
+    filePath: string;
+    messages: LintMessage[];
+    errorCount: number;
+    fatalErrorCount: number;
+    warningCount: number;
+    fixableErrorCount: number;
+    fixableWarningCount: number;
+};
+type LintMessage = {
+    column: number;
+    line: number;
+    endColumn?: number | undefined;
+    endLine?: number | undefined;
+    ruleId: string | null;
+    message: string;
+    messageId?: string | undefined;
+    nodeType?: string | undefined;
+    fatal?: boolean | undefined;
+    severity: 0 | 1 | 2;
+};