eslint-formatter-gitlab 7.0.1 → 7.2.0

package/README.md

@@ -15,6 +15,8 @@ Show ESLint results directly in the
 
 - [Installation](#installation)
 - [Usage](#usage)
+  - [GitLab CI](#gitlab-ci)
+  - [CLI](#cli)
   - [Programmatic usage](#programmatic-usage)
 - [Example](#example)
 - [Configuration](#configuration)
@@ -31,6 +33,8 @@ npm install --save-dev eslint eslint-formatter-gitlab
 
 ## Usage
 
+### GitLab CI
+
 Define a GitLab job to run `eslint`.
 
 `.gitlab-ci.yml`:
@@ -50,9 +54,19 @@ The formatter automatically detects a GitLab CI environment. It detects where to
 quality report based on the GitLab configuration file. It also prints ESLint issues to the GitLab
 job console with links.
 
+### CLI
+
+Specify the `gitlab` formatter when running `eslint` from the command line.
+
+```sh
+npx eslint --format gitlab
+```
+
 ### Programmatic usage
 
-The formatter can be used programmatically using ESLint.
+You probably want to use
+[`eslint-formatter-codeclimate`](https://github.com/remcohaszing/eslint-formatter-codeclimate)
+instead. But if you must, you can load the `gitlab` formatter like this using ESLint.
 
 ```js
 import { ESLint } from 'eslint'

package/lib/eslint-formatter-gitlab.js

@@ -1,4 +1,5 @@
 /**
+ * @import { InspectColorForeground } from 'node:util'
  * @import { ESLint } from 'eslint'
  */
 
@@ -35,18 +36,29 @@ async function getOutputPath(projectDir, jobName) {
   let configContents
   try {
     configContents = await readFile(configPath, 'utf8')
-  } catch {
+  } catch (cause) {
     throw new Error(
       'Could not resolve .gitlab-ci.yml to automatically detect report artifact path.' +
-        ' Please manually provide a path via the ESLINT_CODE_QUALITY_REPORT variable.'
+        ' Please manually provide a path via the ESLINT_CODE_QUALITY_REPORT variable.',
+      { cause }
     )
   }
-  const doc = yaml.parseDocument(configContents, {
+  // A GitLab CI configuration file may start with a header document.
+  // https://docs.gitlab.com/ci/yaml/#header-keywords
+  const docs = yaml.parseAllDocuments(configContents, {
     version: '1.1',
     customTags: [reference]
   })
   const path = [jobName, 'artifacts', 'reports', 'codequality']
-  const location = doc.getIn(path)
+
+  /** @type {unknown} */
+  let location
+  for (const doc of docs) {
+    location = doc.getIn(path)
+    if (location != null) {
+      break
+    }
+  }
   if (typeof location !== 'string' || !location) {
     throw new TypeError(
       `Expected ${path.join('.')} to be one exact path, got: ${JSON.stringify(location)}`
@@ -74,14 +86,16 @@ function plural(count, text) {
  *   The ESLint report results.
  * @param {string} projectDir
  *   The GitLab project directory.
+ * @param {(color: InspectColorForeground, text: string) => string} color
+ *   A function to color text or not.
  * @returns {string}
  *   The ESLint messages converted to a format suitable as output in GitLab CI job logs.
  */
-function gitlabConsoleFormatter(results, projectDir) {
+function gitlabConsoleFormatter(results, projectDir, color) {
   // Severity labels manually padded to have equal lengths and end with spaces
-  const labelFatal = `${styleText('magenta', 'fatal')}  `
-  const labelError = `${styleText('red', 'error')}  `
-  const labelWarn = `${styleText('yellow', 'warn')}   `
+  const labelFatal = `${color('magenta', 'fatal')}  `
+  const labelError = `${color('red', 'error')}  `
+  const labelWarn = `${color('yellow', 'warn')}   `
 
   const lines = ['']
 
@@ -126,7 +140,7 @@ function gitlabConsoleFormatter(results, projectDir) {
         if (message.endLine != null && message.endLine !== message.line) {
           anchor += `-${message.endLine}`
         }
-        line += styleText('blue', `${gitLabBaseURL}${repoFilePath}${anchor}`)
+        line += color('blue', `${gitLabBaseURL}${repoFilePath}${anchor}`)
       } else {
         line += `${filePath}:${message.line}:${message.column}`
       }
@@ -138,9 +152,9 @@ function gitlabConsoleFormatter(results, projectDir) {
   const total = warnings + errors + fatal
   if (total > 0) {
     const details = `(${fatal} fatal, ${plural(errors, 'error')}, ${plural(warnings, 'warning')})`
-    lines.push('', `${styleText('red', '✖')} ${plural(total, 'problem')} ${details}`)
+    lines.push('', `${color('red', '✖')} ${plural(total, 'problem')} ${details}`)
   } else {
-    lines.push(`${styleText('green', '✔')} No problems found`)
+    lines.push(`${color('green', '✔')} No problems found`)
   }
 
   lines.push('')
@@ -167,7 +181,15 @@ async function eslintFormatterGitLab(results, data) {
     await writeFile(outputPath, `${JSON.stringify(issues, null, 2)}\n`)
   }
 
-  return gitlabConsoleFormatter(results, projectDir)
+  return gitlabConsoleFormatter(
+    results,
+    projectDir,
+    data.color
+      ? (color, text) => styleText(color, text, { validateStream: false })
+      : data.color === false
+        ? (color, text) => text
+        : styleText
+  )
 }
 
 export default eslintFormatterGitLab

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "7.0.1",
+  "version": "7.2.0",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "type": "module",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
@@ -38,13 +38,13 @@
     "eslint": ">=9"
   },
   "devDependencies": {
-    "@remcohaszing/eslint": "^12.0.0",
-    "@types/node": "^24.0.0",
-    "c8": "^10.0.0",
+    "@remcohaszing/eslint": "^14.0.0",
+    "@types/node": "^25.0.0",
+    "c8": "^11.0.0",
     "codeclimate-types": "^0.3.0",
     "prettier": "^3.0.0",
     "remark-cli": "^12.0.0",
     "remark-preset-remcohaszing": "^3.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^6.0.0"
   }
 }

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":";AAqJA;;;;;;;GAOG;AACH,gDAPW,iBAAiB,EAAE,QAEnB,qBAAqB,GAEnB,OAAO,CAAC,MAAM,CAAC,CAgB3B;4BAzK0B,QAAQ"}
+{"version":3,"file":"eslint-formatter-gitlab.d.ts","sourceRoot":"","sources":["../lib/eslint-formatter-gitlab.js"],"names":[],"mappings":";AAmKA;;;;;;;GAOG;AACH,gDAPW,iBAAiB,EAAE,QAEnB,qBAAqB,GAEnB,OAAO,CAAC,MAAM,CAAC,CAwB3B;4BA9L0B,QAAQ"}