@darksheep/eslint-formatter-github 0.0.1 → 2.0.1

package/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+## [2.0.1](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.0...eslint-formatter-github-v2.0.1) (2024-06-07)
+
+
+### 📦 Dependencies
+
+* **dev:** update dependency @types/node to v20.14.1 ([#207](https://github.com/DarkSheepSoftware/node-packages/issues/207)) ([5ad7a75](https://github.com/DarkSheepSoftware/node-packages/commit/5ad7a75b29cf1fe8710a70f4179027ff7f156611))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.0 to 2.0.1
+    * @darksheep/package.json bumped from 2.0.0 to 2.0.1
+
+## [2.0.0](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v1.0.0...eslint-formatter-github-v2.0.0) (2024-05-31)
+
+
+### ⚠ BREAKING CHANGES
+
+* Drop node@^18
+
+### 💡 Features
+
+* Bump to latest node lts versions ([#196](https://github.com/DarkSheepSoftware/node-packages/issues/196)) ([60a95cc](https://github.com/DarkSheepSoftware/node-packages/commit/60a95cc41b22c39428d35814c0d5e85830052a14))
+* Drop node@^18 ([5f809a6](https://github.com/DarkSheepSoftware/node-packages/commit/5f809a6b2737db425cde55d58c22375ebcded687))
+
+
+### 📦 Dependencies
+
+* **dev:** update dependency eslint to v9 ([#139](https://github.com/DarkSheepSoftware/node-packages/issues/139)) ([a01a119](https://github.com/DarkSheepSoftware/node-packages/commit/a01a119642704615386e37f2092801e08cf2f1b7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 1.0.0 to 2.0.0
+    * @darksheep/package.json bumped from 1.0.0 to 2.0.0
+
+## 1.0.0 (2024-04-22)
+
+
+### 🧹 Miscellaneous Chores
+
+* Move all packages to the packages directory ([6bc5f93](https://github.com/DarkSheepSoftware/node-packages/commit/6bc5f9395c80d8f7f1721c88a4923b7bc133e9c2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped to 1.0.0
+    * @darksheep/package.json bumped to 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/eslint-formatter-github",
-  "version": "0.0.1",
+  "version": "2.0.1",
   "description": "ESLint + Github actions",
   "license": "UNLICENCED",
   "type": "commonjs",
@@ -16,16 +16,16 @@
     "prepack": "tsc"
   },
   "dependencies": {
-    "@darksheep/github-actions": "~0.0.0",
-    "@darksheep/package.json": "~0.0.1"
+    "@darksheep/github-actions": "2.0.1",
+    "@darksheep/package.json": "2.0.1"
   },
   "devDependencies": {
-    "@darksheep/eslint": "~4.3.0",
-    "@types/node": "~20.12.0",
+    "@darksheep/eslint": "~4.4.0",
+    "@types/node": "~20.14.0",
     "eslint": "~8.57.0",
     "typescript": "~5.4.0"
   },
   "engines": {
-    "node": "^18 || ^20 || ^21"
+    "node": "^20.13.1 || ^22.2.0"
   }
 }

package/src/index.js

@@ -40,65 +40,99 @@ 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());
+  if (typeof process.exitCode !== 'number') {
+    process.exitCode = 0;
+  }
 
-  const total = errorCount + warningCount;
-  process.exitCode = errorCount;
+  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

@@ -1,27 +1,4 @@
 export = formatter;
-/**
- * @typedef {Object} LintMessage
- * @property {number} column
- * @property {number} line
- * @property {number} [endColumn]
- * @property {number} [endLine]
- * @property {string | null} ruleId
- * @property {string} message
- * @property {string} [messageId]
- * @property {string} [nodeType]
- * @property {boolean} [fatal]
- * @property {0 | 1 | 2} severity
- */
-/**
- * @typedef {Object} LintResult
- * @property {string} filePath
- * @property {LintMessage[]} messages
- * @property {number} errorCount
- * @property {number} fatalErrorCount
- * @property {number} warningCount
- * @property {number} fixableErrorCount
- * @property {number} fixableWarningCount
- */
 /**
  * @param {LintResult[]} fileResults The eslint results
  * @returns {string}