@darksheep/eslint-formatter-github 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,131 @@
 # Changelog
 
+## [2.1.0](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.10...eslint-formatter-github-v2.1.0) (2025-01-11)
+
+
+### 🌟 Features
+
+* Add "ruleId" to error lint messages ([#534](https://github.com/DarkSheepSoftware/node-packages/issues/534)) ([99b6c31](https://github.com/DarkSheepSoftware/node-packages/commit/99b6c310561d92c84a4a9f5fcfb687e184a9209f))
+
+## [2.0.10](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.9...eslint-formatter-github-v2.0.10) (2024-10-21)
+
+
+### 🩹 Fixes
+
+* only write endLine and endColumn if strings ([a568b63](https://github.com/DarkSheepSoftware/node-packages/commit/a568b63eb03a0c1d1c17e8983129bac0d34c3e1c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.8 to 2.0.9
+    * @darksheep/package.json bumped from 3.0.0 to 3.0.1
+
+## [2.0.9](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.8...eslint-formatter-github-v2.0.9) (2024-09-13)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.7 to 2.0.8
+    * @darksheep/package.json bumped from 2.0.7 to 3.0.0
+
+## [2.0.8](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.7...eslint-formatter-github-v2.0.8) (2024-09-12)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.6 to 2.0.7
+    * @darksheep/package.json bumped from 2.0.6 to 2.0.7
+
+## [2.0.7](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.6...eslint-formatter-github-v2.0.7) (2024-08-28)
+
+
+### 🩹 Fixes
+
+* remove calls to "console.info" ([#342](https://github.com/DarkSheepSoftware/node-packages/issues/342)) ([56f39a4](https://github.com/DarkSheepSoftware/node-packages/commit/56f39a436a852ce63c2aa355a56698ac179dfe8b))
+
+
+### 🔨 Code Refactoring
+
+* Remove all eslint inline suppressions ([dc1d62f](https://github.com/DarkSheepSoftware/node-packages/commit/dc1d62f5fa9cd50f884d6b68a30d448685c6c2d2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.5 to 2.0.6
+    * @darksheep/package.json bumped from 2.0.5 to 2.0.6
+
+## [2.0.6](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.5...eslint-formatter-github-v2.0.6) (2024-08-12)
+
+
+### 🧹 Chores
+
+* update env access ([#309](https://github.com/DarkSheepSoftware/node-packages/issues/309)) ([c0bb192](https://github.com/DarkSheepSoftware/node-packages/commit/c0bb192deb0d016f3893e14ab6270461d5f5b07d))
+
+## [2.0.5](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.4...eslint-formatter-github-v2.0.5) (2024-08-09)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.4 to 2.0.5
+    * @darksheep/package.json bumped from 2.0.4 to 2.0.5
+
+## [2.0.4](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.3...eslint-formatter-github-v2.0.4) (2024-08-01)
+
+
+### 📦 Dependencies
+
+* **dev:** update dependency eslint to ~9.8.0 ([#284](https://github.com/DarkSheepSoftware/node-packages/issues/284)) ([dc02a80](https://github.com/DarkSheepSoftware/node-packages/commit/dc02a801cb982cd3ed2bf685db62a21b6c2c15cd))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.3 to 2.0.4
+    * @darksheep/package.json bumped from 2.0.3 to 2.0.4
+
+## [2.0.3](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.2...eslint-formatter-github-v2.0.3) (2024-07-23)
+
+
+### 📦 Dependencies
+
+* **dev:** update dependency @darksheep/eslint to v5 ([25aabab](https://github.com/DarkSheepSoftware/node-packages/commit/25aababd9295e3e47b945c91b5d6fbf121f8168b))
+* **dev:** update dependency eslint to ~9.7.0 ([#263](https://github.com/DarkSheepSoftware/node-packages/issues/263)) ([af98723](https://github.com/DarkSheepSoftware/node-packages/commit/af9872336b01026496bc1a48807fd396eb361483))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.2 to 2.0.3
+    * @darksheep/package.json bumped from 2.0.2 to 2.0.3
+
+## [2.0.2](https://github.com/DarkSheepSoftware/node-packages/compare/eslint-formatter-github-v2.0.1...eslint-formatter-github-v2.0.2) (2024-07-02)
+
+
+### 📦 Dependencies
+
+* **dev:** update dependency eslint to v9 ([#252](https://github.com/DarkSheepSoftware/node-packages/issues/252)) ([7473b18](https://github.com/DarkSheepSoftware/node-packages/commit/7473b18e59c132f41e03cd6237842205bc23d08e))
+* **dev:** update dependency typescript to ~5.5.0 ([#242](https://github.com/DarkSheepSoftware/node-packages/issues/242)) ([68413b5](https://github.com/DarkSheepSoftware/node-packages/commit/68413b57ef85df879c33243566618a2ecb700051))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/github-actions bumped from 2.0.1 to 2.0.2
+    * @darksheep/package.json bumped from 2.0.1 to 2.0.2
+
 ## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/eslint-formatter-github",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "ESLint + Github actions",
   "license": "UNLICENCED",
   "type": "commonjs",
@@ -8,22 +8,15 @@
   "types": "./types/index.d.ts",
   "files": [
     "./src",
-    "./types"
+    "./types",
+    "!*.test.*"
   ],
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
     "prepack": "tsc"
   },
   "dependencies": {
-    "@darksheep/github-actions": "2.0.1",
-    "@darksheep/package.json": "2.0.1"
-  },
-  "devDependencies": {
-    "@darksheep/eslint": "~4.4.0",
-    "@types/node": "~20.14.0",
-    "eslint": "~8.57.0",
-    "typescript": "~5.4.0"
+    "@darksheep/github-actions": "2.0.9",
+    "@darksheep/package.json": "3.0.1"
   },
   "engines": {
     "node": "^20.13.1 || ^22.2.0"

package/src/index.js

@@ -1,47 +1,44 @@
-/* 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
+ * @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;
+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
+ * @property {number} column - The start of error column number.
+ * @property {number} line - The start of error line number.
+ * @property {number} [endColumn] - The end of error column number.
+ * @property {number} [endLine] - The end of error line number.
+ * @property {string | null} ruleId - The lint rule id.
+ * @property {string} message - The lint message.
+ * @property {string} [messageId] - The lint message id.
+ * @property {string} [nodeType] - The estree node.
+ * @property {boolean} [fatal] - Linting fatality flag.
+ * @property {0 | 1 | 2} severity - Lint 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
+ * @property {string} filePath - Linted file path.
+ * @property {LintMessage[]} messages - Collection of messages for the file.
+ * @property {number} errorCount - Number of errors.
+ * @property {number} fatalErrorCount - Number of fatal errors.
+ * @property {number} warningCount - Number of warnings.
+ * @property {number} fixableErrorCount - Number of fixable errors.
+ * @property {number} fixableWarningCount - Number of fixable warnings.
  */
 
 /**
- * @param {LintResult[]} fileResults The eslint results
+ * @param {LintResult[]} fileResults - The linting results.
  * @returns {Record<'warningCount' | 'errorCount', number>}
  */
 function counters(fileResults) {
@@ -60,7 +57,7 @@ function counters(fileResults) {
 }
 
 /**
- * @param {LintResult} fileResult The eslint single file result
+ * @param {LintResult} fileResult - The single file result.
  * @returns {string[]}
  */
 function formatFileResult(fileResult) {
@@ -72,7 +69,7 @@ function formatFileResult(fileResult) {
   );
 
   for (const result of fileResult.messages) {
-    const message = result.ruleId == null || result.ruleId === ''
+    const message = (result.ruleId != null && result.ruleId !== '')
       ? `[${result.ruleId}] ${result.message}`
       : result.message;
 
@@ -81,16 +78,29 @@ function formatFileResult(fileResult) {
       file: filePath,
       line: result.line,
       col: result.column,
-      endLine: result.endLine,
-      endColumn: result.endColumn,
     };
 
+    if (typeof result.endLine === 'string') {
+      context.endLine = result.endLine;
+    }
+
+    if (typeof result.endColumn === 'string') {
+      context.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 */
+      case 0: {
+        lines.push(setNotice(message, context));
+        break;
+      }
+      case 1: {
+        lines.push(setWarning(message, context));
+        break;
+      }
+      case 2: {
+        lines.push(setError(message, context));
+        break;
+      }
     }
   }
 
@@ -98,7 +108,7 @@ function formatFileResult(fileResult) {
 }
 
 /**
- * @param {LintResult[]} fileResults The eslint results
+ * @param {LintResult[]} fileResults - The linting results.
  * @returns {string}
  */
 function formatter(fileResults) {

package/types/index.d.ts

@@ -1,30 +1,81 @@
 export = formatter;
 /**
- * @param {LintResult[]} fileResults The eslint results
+ * @param {LintResult[]} fileResults - The linting results.
  * @returns {string}
  */
 declare function formatter(fileResults: LintResult[]): string;
 declare namespace formatter {
     export { LintMessage, LintResult };
 }
+type LintMessage = {
+    /**
+     * - The start of error column number.
+     */
+    column: number;
+    /**
+     * - The start of error line number.
+     */
+    line: number;
+    /**
+     * - The end of error column number.
+     */
+    endColumn?: number;
+    /**
+     * - The end of error line number.
+     */
+    endLine?: number;
+    /**
+     * - The lint rule id.
+     */
+    ruleId: string | null;
+    /**
+     * - The lint message.
+     */
+    message: string;
+    /**
+     * - The lint message id.
+     */
+    messageId?: string;
+    /**
+     * - The estree node.
+     */
+    nodeType?: string;
+    /**
+     * - Linting fatality flag.
+     */
+    fatal?: boolean;
+    /**
+     * - Lint severity.
+     */
+    severity: 0 | 1 | 2;
+};
 type LintResult = {
+    /**
+     * - Linted file path.
+     */
     filePath: string;
+    /**
+     * - Collection of messages for the file.
+     */
     messages: LintMessage[];
+    /**
+     * - Number of errors.
+     */
     errorCount: number;
+    /**
+     * - Number of fatal errors.
+     */
     fatalErrorCount: number;
+    /**
+     * - Number of warnings.
+     */
     warningCount: number;
+    /**
+     * - Number of fixable errors.
+     */
     fixableErrorCount: number;
+    /**
+     * - Number of fixable warnings.
+     */
     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;
-};