@darksheep/eslint-formatter-github 0.0.0

package/README.md

@@ -0,0 +1,6 @@
+# @darksheep/eslint-formatter-github
+
+```
+npm install --save-dev eslint @darksheep/eslint-formatter-github
+npx eslint . --format @darksheep/github
+```

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@darksheep/eslint-formatter-github",
+  "version": "0.0.0",
+  "description": "ESLint + Github actions",
+  "license": "UNLICENCED",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./types/index.d.ts",
+  "files": [
+    "./src"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "dependencies": {
+    "@darksheep/github-actions": "~0.0.0",
+    "@darksheep/package.json": "~0.0.1"
+  },
+  "devDependencies": {
+    "@darksheep/eslint": "~4.3.0",
+    "@types/node": "~20.12.0",
+    "eslint": "~8.57.0",
+    "typescript": "~5.4.0"
+  },
+  "engines": {
+    "node": "^18 || ^20 || ^21"
+  }
+}

package/src/index.js

@@ -0,0 +1,105 @@
+/* eslint jsdoc/require-property-description: 0 */
+const path = require('node:path');
+const { setNotice, setWarning, setError, startGroup, endGroup } = require('@darksheep/github-actions');
+const { getPackageJson } = require('@darksheep/package.json/sync');
+
+/**
+ * @param {string} word The word to pluralise
+ * @param {number} count The number of items
+ * @returns {string}
+ */
+function plural(word, count) {
+  return (count === 1 ? word : `${word}s`);
+}
+
+const {
+  GITHUB_WORKSPACE = process.cwd(),
+} = process.env;
+
+/**
+ * @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}
+ */
+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}`));
+
+  for (const fileResult of fileResults) {
+    const filePath = path.relative(
+      GITHUB_WORKSPACE,
+      fileResult.filePath,
+    );
+
+    warningCount += fileResult.warningCount;
+    errorCount += fileResult.errorCount;
+
+    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;
+      }
+    }
+  }
+
+  lines.push(endGroup());
+
+  const total = errorCount + warningCount;
+  process.exitCode = errorCount;
+
+  lines.push(`${total} problem(s) (${errorCount} ${plural('error', errorCount)}, ${warningCount} ${plural('warning', warningCount)})`);
+  return lines.join('\n');
+}
+
+module.exports = formatter;