eslint-formatter-gitlab 5.0.0 → 5.1.0

package/index.d.ts

@@ -0,0 +1,11 @@
+export = eslintFormatterGitLab;
+/**
+ * @param {import('eslint').ESLint.LintResult[]} results
+ *   The ESLint report results.
+ * @param {import('eslint').ESLint.LintResultData} data
+ *   The ESLint report result data.
+ * @returns {string}
+ *   The ESLint output to print to the console.
+ */
+declare function eslintFormatterGitLab(results: import('eslint').ESLint.LintResult[], data: import('eslint').ESLint.LintResultData): string;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";AA0PA;;;;;;;GAOG;AACH,gDAPW,OAAO,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,QAEpC,OAAO,QAAQ,EAAE,MAAM,CAAC,cAAc,GAEpC,MAAM,CAmBlB"}

package/index.js

@@ -1,10 +1,3 @@
-/**
- * @typedef {import('eslint').ESLint.LintResult} LintResult
- * @typedef {import('eslint').ESLint.LintResultData} LintResultData
- * @typedef {import('eslint').Linter.LintMessage} LintMessage
- * @typedef {import('codeclimate-types').Issue} Issue
- */
-
 const { createHash } = require('node:crypto')
 const { existsSync, lstatSync, mkdirSync, readFileSync, writeFileSync } = require('node:fs')
 const { EOL } = require('node:os')
@@ -23,9 +16,7 @@ const {
   GITLAB_CI
 } = process.env
 
-/**
- * @type {yaml.CollectionTag}
- */
+/** @type {yaml.CollectionTag} */
 const reference = {
   tag: '!reference',
   collection: 'seq',
@@ -36,7 +27,8 @@ const reference = {
 }
 
 /**
- * @returns {string} The output path of the code quality artifact.
+ * @returns {string}
+ *   The output path of the code quality artifact.
  */
 function getOutputPath() {
   const configPath = join(CI_PROJECT_DIR, CI_CONFIG_PATH)
@@ -64,10 +56,14 @@ function getOutputPath() {
 }
 
 /**
- * @param {string} filePath The path to the linted file.
- * @param {LintMessage} message The ESLint report message.
- * @param {Set<string>} hashes Hashes already encountered. Used to avoid duplicate hashes
- * @returns {string} The fingerprint for the ESLint report message.
+ * @param {string} filePath
+ *   The path to the linted file.
+ * @param {import('eslint').Linter.LintMessage} message
+ *   The ESLint report message.
+ * @param {Set<string>} hashes
+ *   Hashes already encountered. Used to avoid duplicate hashes
+ * @returns {string}
+ *   The fingerprint for the ESLint report message.
  */
 function createFingerprint(filePath, message, hashes) {
   const md5 = createHash('md5')
@@ -95,12 +91,15 @@ function createFingerprint(filePath, message, hashes) {
 }
 
 /**
- * @param {LintResult[]} results The ESLint report results.
- * @param {LintResultData} data The ESLint report result data.
- * @returns {Issue[]} The ESLint messages in the form of a GitLab code quality report.
+ * @param {import('eslint').ESLint.LintResult[]} results
+ *   The ESLint report results.
+ * @param {import('eslint').ESLint.LintResultData} data
+ *   The ESLint report result data.
+ * @returns {import('codeclimate-types').Issue[]}
+ *   The ESLint messages in the form of a GitLab code quality report.
  */
 function convert(results, data) {
-  /** @type {Issue[]} */
+  /** @type {import('codeclimate-types').Issue[]} */
   const messages = []
 
   /** @type {Set<string>} */
@@ -110,7 +109,7 @@ function convert(results, data) {
     const relativePath = relative(CI_PROJECT_DIR, result.filePath)
 
     for (const message of result.messages) {
-      /** @type {Issue} */
+      /** @type {import('codeclimate-types').Issue} */
       const issue = {
         type: 'issue',
         categories: ['Style'],
@@ -126,26 +125,36 @@ function convert(results, data) {
           }
         }
       }
-      if (message.ruleId && message.ruleId in data.rulesMeta) {
-        const { docs, type } = data.rulesMeta[message.ruleId]
-        if (type === 'problem') {
-          issue.categories.unshift('Bug Risk')
-        }
+      messages.push(issue)
 
-        if (docs) {
-          let body = docs.description || ''
-          if (docs.url) {
-            if (body) {
-              body += '\n\n'
-            }
-            body += `[${message.ruleId}](${docs.url})`
-          }
-          if (body) {
-            issue.content = { body }
-          }
+      if (!message.ruleId) {
+        continue
+      }
+
+      if (!data.rulesMeta[message.ruleId]) {
+        continue
+      }
+
+      const { docs, type } = data.rulesMeta[message.ruleId]
+      if (type === 'problem') {
+        issue.categories.unshift('Bug Risk')
+      }
+
+      if (!docs) {
+        continue
+      }
+
+      let body = docs.description || ''
+      if (docs.url) {
+        if (body) {
+          body += '\n\n'
         }
+        body += `[${message.ruleId}](${docs.url})`
+      }
+
+      if (body) {
+        issue.content = { body }
       }
-      messages.push(issue)
     }
   }
   return messages
@@ -154,18 +163,22 @@ function convert(results, data) {
 /**
  * Make a text singular or plural based on the count.
  *
- * @param {number} count The count of the data.
- * @param {string} text The text to make singular or plural.
- * @returns {string} The formatted text.
+ * @param {number} count
+ *   The count of the data.
+ * @param {string} text
+ *   The text to make singular or plural.
+ * @returns {string}
+ *   The formatted text.
  */
 function plural(count, text) {
   return `${count} ${text}${count === 1 ? '' : 's'}`
 }
 
 /**
- * @param {LintResult[]} results The ESLint report results.
- * @returns {string} The ESLint messages converted to a format
- *   suitable as output in GitLab CI job logs.
+ * @param {import('eslint').ESLint.LintResult[]} results
+ *   The ESLint report results.
+ * @returns {string}
+ *   The ESLint messages converted to a format suitable as output in GitLab CI job logs.
  */
 function gitlabConsoleFormatter(results) {
   // Severity labels manually padded to have equal lengths and end with spaces
@@ -236,10 +249,14 @@ function gitlabConsoleFormatter(results) {
 }
 
 /**
- * @param {LintResult[]} results The ESLint report results.
- * @param {LintResultData} data The ESLint report result data.
+ * @param {import('eslint').ESLint.LintResult[]} results
+ *   The ESLint report results.
+ * @param {import('eslint').ESLint.LintResultData} data
+ *   The ESLint report result data.
+ * @returns {string}
+ *   The ESLint output to print to the console.
  */
-module.exports = (results, data) => {
+function eslintFormatterGitLab(results, data) {
   /* c8 ignore start */
   if (GITLAB_CI === 'true') {
     chalk.level = 1
@@ -256,3 +273,5 @@ module.exports = (results, data) => {
 
   return gitlabConsoleFormatter(results)
 }
+
+module.exports = eslintFormatterGitLab

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
   "license": "MIT",
@@ -10,9 +10,10 @@
   "bugs": "https://gitlab.com/remcohaszing/eslint-formatter-gitlab/-/issues",
   "exports": "./index.js",
   "files": [
-    "index.js"
+    "index.*"
   ],
   "scripts": {
+    "prepack": "tsc --build",
     "test": "c8 node --test --test-reporter @reporters/junit --test-reporter-destination=junit.xml --test-reporter spec --test-reporter-destination stdout"
   },
   "keywords": [
@@ -27,7 +28,7 @@
     "yaml": "^2.0.0"
   },
   "peerDependencies": {
-    "eslint": "^5 || ^6 || ^7 || ^8"
+    "eslint": ">=5"
   },
   "devDependencies": {
     "@reporters/junit": "^1.0.0",
@@ -36,10 +37,10 @@
     "c8": "^8.0.0",
     "codeclimate-types": "^0.3.0",
     "eslint": "^8.0.0",
-    "eslint-config-remcohaszing": "^9.0.0",
-    "prettier": "^2.0.0",
+    "eslint-config-remcohaszing": "^10.0.0",
+    "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
-    "remark-preset-remcohaszing": "^1.0.0",
+    "remark-preset-remcohaszing": "^2.0.0",
     "typescript": "^5.0.0"
   }
 }