eslint-formatter-gitlab 6.0.0 → 6.0.1

package/README.md

@@ -37,10 +37,10 @@ Define a GitLab job to run `eslint`.
 
 ```yaml
 eslint:
-  image: node:20-alpine
+  image: node:22-alpine
   script:
     - npm ci
-    - npx eslint --format gitlab .
+    - npx eslint --format gitlab
   artifacts:
     reports:
       codequality: gl-codequality.json

package/lib/eslint-formatter-gitlab.js

@@ -1,13 +1,12 @@
 /**
- * @import { Issue } from 'codeclimate-types'
- * @import { ESLint, Linter } from 'eslint'
+ * @import { ESLint } from 'eslint'
  */
 
-import { createHash } from 'node:crypto'
 import { mkdir, readFile, writeFile } from 'node:fs/promises'
 import { dirname, join, relative, resolve } from 'node:path'
 import { styleText } from 'node:util'
 
+import { toCodeClimate } from 'eslint-formatter-codeclimate'
 import yaml from 'yaml'
 
 /** @type {yaml.CollectionTag} */
@@ -56,113 +55,6 @@ async function getOutputPath(projectDir, jobName) {
   return resolve(projectDir, location)
 }
 
-/**
- * @param {string} filePath
- *   The path to the linted file.
- * @param {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')
-  md5.update(filePath)
-  if (message.ruleId) {
-    md5.update(message.ruleId)
-  }
-  md5.update(message.message)
-
-  // Create copy of hash since md5.digest() will finalize it, not allowing us to .update() again
-  let md5Tmp = md5.copy()
-  let hash = md5Tmp.digest('hex')
-
-  while (hashes.has(hash)) {
-    // Hash collision. This happens if we encounter the same ESLint message in one file
-    // multiple times. Keep generating new hashes until we get a unique one.
-    md5.update(hash)
-
-    md5Tmp = md5.copy()
-    hash = md5Tmp.digest('hex')
-  }
-
-  hashes.add(hash)
-  return hash
-}
-
-/**
- * @param {ESLint.LintResult[]} results
- *   The ESLint report results.
- * @param {ESLint.LintResultData} data
- *   The ESLint report result data.
- * @param {string} projectDir
- *   The GitLab project directory.
- * @returns {Issue[]}
- *   The ESLint messages in the form of a GitLab code quality report.
- */
-function convert(results, data, projectDir) {
-  /** @type {Issue[]} */
-  const messages = []
-
-  /** @type {Set<string>} */
-  const hashes = new Set()
-
-  for (const result of results) {
-    const relativePath = relative(projectDir, result.filePath)
-
-    for (const message of result.messages) {
-      /** @type {Issue} */
-      const issue = {
-        type: 'issue',
-        categories: ['Style'],
-        check_name: message.ruleId ?? '',
-        description: message.message,
-        severity: message.fatal ? 'critical' : message.severity === 2 ? 'major' : 'minor',
-        fingerprint: createFingerprint(relativePath, message, hashes),
-        location: {
-          path: relativePath,
-          lines: {
-            begin: message.line,
-            end: message.endLine ?? message.line
-          }
-        }
-      }
-      messages.push(issue)
-
-      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 }
-      }
-    }
-  }
-  return messages
-}
-
 /**
  * Make a text singular or plural based on the count.
  *
@@ -268,7 +160,7 @@ async function eslintFormatterGitLab(results, data) {
   const projectDir = process.env.CI_PROJECT_DIR ?? data.cwd
   const jobName = process.env.CI_JOB_NAME
   if (jobName || outputPath) {
-    const issues = convert(results, data, projectDir)
+    const issues = toCodeClimate(results, data.rulesMeta, projectDir)
     outputPath ||= await getOutputPath(projectDir, jobName)
     const dir = dirname(outputPath)
     await mkdir(dir, { recursive: true })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "type": "module",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
@@ -31,6 +31,7 @@
     "gitlab-ci"
   ],
   "dependencies": {
+    "eslint-formatter-codeclimate": "^1.0.0",
     "yaml": "^2.0.0"
   },
   "peerDependencies": {

package/types/eslint-formatter-gitlab.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslint-formatter-gitlab.d.ts","sourceRoot":"","sources":["../lib/eslint-formatter-gitlab.js"],"names":[],"mappings":";AAiQA;;;;;;;GAOG;AACH,gDAPW,iBAAiB,EAAE,QAEnB,qBAAqB,GAEnB,OAAO,CAAC,MAAM,CAAC,CAgB3B;4BApRkC,QAAQ"}
+{"version":3,"file":"eslint-formatter-gitlab.d.ts","sourceRoot":"","sources":["../lib/eslint-formatter-gitlab.js"],"names":[],"mappings":";AAqJA;;;;;;;GAOG;AACH,gDAPW,iBAAiB,EAAE,QAEnB,qBAAqB,GAEnB,OAAO,CAAC,MAAM,CAAC,CAgB3B;4BAzK0B,QAAQ"}