eslint-formatter-gitlab 3.0.0 → 5.0.0

package/LICENSE.md

@@ -3,7 +3,7 @@
 Copyright © 2018 Remco Haszing
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-associated documentation files (the "Software"), to deal in the Software without restriction,
+associated documentation files (the “Software”), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute,
 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
@@ -11,7 +11,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all copies or substantial
 portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
 NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
 OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

package/README.md

@@ -1,10 +1,21 @@
 # ESLint Formatter for GitLab
 
-> Show ESLint results directly in the [GitLab code quality] results
+Show ESLint results directly in the
+[GitLab code quality](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html)
+results.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Example](#example)
+- [Configuration](#configuration)
+- [License](#license)
 
 ## Requirements
 
-This requires at least GitLab Bronze or Starter 11.5 and at least ESLint 5.
+This package requires at least Node.js 18 and ESLint 5.
 
 ## Installation
 
@@ -14,13 +25,15 @@ Install `eslint` and `eslint-formatter-gitlab` using your package manager.
 npm install --save-dev eslint eslint-formatter-gitlab
 ```
 
+## Usage
+
 Define a GitLab job to run `eslint`.
 
 _.gitlab-ci.yml_:
 
 ```yaml
 eslint:
-  image: node:14-alpine
+  image: node:20-alpine
   script:
     - npm ci
     - npx eslint --format gitlab .
@@ -29,28 +42,22 @@ eslint:
       codequality: gl-codequality.json
 ```
 
-The formatter will automatically detect a GitLab CI environment. It will detect where to output the
-code quality report based on the GitLab configuration file.
+The formatter automatically detects a GitLab CI environment. It detects where to output the code
+quality report based on the GitLab configuration file.
 
 ## Example
 
-An example of the results can be seen in [Merge Request !1] of `eslint-formatter-gitlab` itself.
-
-## Configuration Options
-
-ESLint formatters don’t take any configuration options. In order to still allow some way of
-configuration, options are passed using environment variables.
-
-| Environment Variable         | Description                                                                                                                                                    |
-| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `ESLINT_CODE_QUALITY_REPORT` | The location to store the code quality report. By default it will detect the location of the codequality artifact defined in the GitLab CI configuration file. |
+An example of the results can be seen in
+[Merge Request !1](https://gitlab.com/remcohaszing/eslint-formatter-gitlab/merge_requests/1) of
+`eslint-formatter-gitlab` itself.
 
-## Upgrading
+## Configuration
 
-### to v3
+ESLint formatters don’t take any configuration options. `eslint-formatter-gitlab` uses GitLab’s
+[predefined environment variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
+to configure the output. In addition, the environment variable `ESLINT_CODE_QUALITY_REPORT` is used
+to override the location to store the code quality report.
 
-- Support for the environment variable `ESLINT_FORMATTER` has been removed, console output now
-  always uses a builtin formatter.
+## License
 
-[gitlab code quality]: https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html
-[merge request !1]: https://gitlab.com/remcohaszing/eslint-formatter-gitlab/merge_requests/1
+[MIT](LICENSE.md) © [Remco Haszing](https://gitlab.com/remcohaszing)

package/index.js

@@ -1,189 +1,258 @@
-const { createHash } = require('crypto');
-const { existsSync, lstatSync, mkdirSync, readFileSync, writeFileSync } = require('fs');
-const { EOL } = require('os');
-const { dirname, join, relative, resolve } = require('path');
+/**
+ * @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')
+const { dirname, join, relative, resolve } = require('node:path')
 
-// eslint-disable-next-line unicorn/import-style
-const chalk = require('chalk');
-const yaml = require('js-yaml');
+const chalk = require('chalk')
+const yaml = require('yaml')
 
 const {
+  CI_COMMIT_SHORT_SHA,
   CI_CONFIG_PATH = '.gitlab-ci.yml',
   CI_JOB_NAME,
   CI_PROJECT_DIR = process.cwd(),
   CI_PROJECT_URL,
-  CI_COMMIT_SHORT_SHA,
   ESLINT_CODE_QUALITY_REPORT,
-  GITLAB_CI,
-  NODE_ENV,
-} = process.env;
+  GITLAB_CI
+} = process.env
+
+/**
+ * @type {yaml.CollectionTag}
+ */
+const reference = {
+  tag: '!reference',
+  collection: 'seq',
+  default: false,
+  resolve() {
+    // We only allow the syntax. We don’t actually resolve the reference.
+  }
+}
 
 /**
  * @returns {string} The output path of the code quality artifact.
  */
 function getOutputPath() {
-  const configPath = join(CI_PROJECT_DIR, CI_CONFIG_PATH);
+  const configPath = join(CI_PROJECT_DIR, CI_CONFIG_PATH)
   // GitlabCI allows a custom configuration path which can be a URL or a path relative to another
   // project. In these cases CI_CONFIG_PATH is empty and we'll have to require the user provide
   // ESLINT_CODE_QUALITY_REPORT.
   if (!existsSync(configPath) || !lstatSync(configPath).isFile()) {
     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.',
-    );
-  }
-  const jobs = yaml.load(readFileSync(configPath, 'utf-8'));
-  const { artifacts } = jobs[CI_JOB_NAME];
-  const location = artifacts && artifacts.reports && artifacts.reports.codequality;
-  const msg = `Expected ${CI_JOB_NAME}.artifacts.reports.codequality to be one exact path`;
-  if (!location) {
-    throw new Error(`${msg}, but no value was found.`);
+        ' Please manually provide a path via the ESLINT_CODE_QUALITY_REPORT variable.'
+    )
   }
-  if (Array.isArray(location)) {
-    throw new TypeError(`${msg}, but found an array instead.`);
+  const doc = yaml.parseDocument(readFileSync(configPath, 'utf8'), {
+    version: '1.1',
+    customTags: [reference]
+  })
+  const path = [CI_JOB_NAME, 'artifacts', 'reports', 'codequality']
+  const location = doc.getIn(path)
+  if (typeof location !== 'string' || !location) {
+    throw new TypeError(
+      `Expected ${path.join('.')} to be one exact path, got: ${JSON.stringify(location)}`
+    )
   }
-  return resolve(CI_PROJECT_DIR, location);
+  return resolve(CI_PROJECT_DIR, location)
 }
 
 /**
- * @param {string} filePath - The path to the linted file.
- * @param {object} message - The ESLint report message.
+ * @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.
  */
-function createFingerprint(filePath, message) {
-  const md5 = createHash('md5');
-  md5.update(filePath);
+function createFingerprint(filePath, message, hashes) {
+  const md5 = createHash('md5')
+  md5.update(filePath)
   if (message.ruleId) {
-    md5.update(message.ruleId);
+    md5.update(message.ruleId)
   }
-  md5.update(message.message);
-  return md5.digest('hex');
+  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 {object[]} results - The ESLint report results.
- * @returns {object[]} The ESLint messages in the form of a GitLab code quality report.
+ * @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.
  */
-function convert(results) {
-  const messages = [];
+function convert(results, data) {
+  /** @type {Issue[]} */
+  const messages = []
+
+  /** @type {Set<string>} */
+  const hashes = new Set()
+
   for (const result of results) {
+    const relativePath = relative(CI_PROJECT_DIR, result.filePath)
+
     for (const message of result.messages) {
-      const relativePath = relative(CI_PROJECT_DIR, result.filePath);
-      // https://github.com/codeclimate/spec/blob/master/SPEC.md#data-types
-      messages.push({
+      /** @type {Issue} */
+      const issue = {
+        type: 'issue',
+        categories: ['Style'],
+        check_name: message.ruleId ?? '',
         description: message.message,
-        severity: message.severity === 2 ? 'major' : 'minor',
-        fingerprint: createFingerprint(relativePath, 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
+          }
+        }
+      }
+      if (message.ruleId && message.ruleId in data.rulesMeta) {
+        const { docs, type } = data.rulesMeta[message.ruleId]
+        if (type === 'problem') {
+          issue.categories.unshift('Bug Risk')
+        }
+
+        if (docs) {
+          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;
+  return messages
 }
 
 /**
- * @param {object} message - The ESLint report message.
- * @returns {boolean} `true` if the message is at error level, `false` if it represents a warning
+ * 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.
  */
-function messageIsLevelError(message) {
-  return message.fatal || message.severity === 2;
+function plural(count, text) {
+  return `${count} ${text}${count === 1 ? '' : 's'}`
 }
 
 /**
- * @param {object[]} results - The ESLint report results.
- * @returns {object} Statistics about the number of problems at various levels
- * and length of contained description strings.
- */
-function calculateResultsStats(results) {
-  const stats = { total: 0, errors: 0, warnings: 0, maxRuleIdLength: 0, maxMsgLength: 0 };
-
-  for (const result of results) {
-    for (const message of result.messages) {
-      const isError = messageIsLevelError(message);
-      stats.errors += isError ? 1 : 0;
-      stats.warnings += isError ? 0 : 1;
-      stats.maxRuleIdLength = message.ruleId
-        ? Math.max(stats.maxRuleIdLength, message.ruleId.length)
-        : stats.maxRuleIdLength;
-      stats.maxMsgLength = Math.max(stats.maxMsgLength, message.message.length);
-    }
-  }
-
-  stats.total = stats.warnings + stats.errors;
-
-  return stats;
-}
-
-const plural = (count, text) => `${count} ${text}${count === 1 ? '' : 's'}`;
-
-/**
- * @param {object[]} results - The ESLint report results.
+ * @param {LintResult[]} results The ESLint report results.
  * @returns {string} The ESLint messages converted to a format
- * suitable as output in GitLab CI job logs.
+ *   suitable as output in GitLab CI job logs.
  */
 function gitlabConsoleFormatter(results) {
   // Severity labels manually padded to have equal lengths and end with spaces
-  const labelError = `${chalk.red('error')}  `;
-  const labelWarn = `${chalk.yellow('warn')}   `;
+  const labelFatal = `${chalk.magenta('fatal')}  `
+  const labelError = `${chalk.red('error')}  `
+  const labelWarn = `${chalk.yellow('warn')}   `
 
-  const lines = [''];
+  const lines = ['']
 
-  let gitLabBaseURL;
+  /** @type {string | undefined} */
+  let gitLabBaseURL
   if (CI_PROJECT_URL && CI_COMMIT_SHORT_SHA) {
-    gitLabBaseURL = `${CI_PROJECT_URL}/-/blob/${CI_COMMIT_SHORT_SHA}/`;
+    gitLabBaseURL = `${CI_PROJECT_URL}/-/blob/${CI_COMMIT_SHORT_SHA}/`
   }
 
-  const stats = calculateResultsStats(results);
+  let fatal = 0
+  let errors = 0
+  let warnings = 0
+  let maxRuleIdLength = 0
+  let maxMsgLength = 0
 
   for (const result of results) {
-    const { filePath, messages } = result;
-    const repoFilePath = relative(CI_PROJECT_DIR, filePath);
+    fatal += result.fatalErrorCount
+    errors += result.errorCount - result.fatalErrorCount
+    warnings += result.warningCount
+    for (const message of result.messages) {
+      if (message.ruleId) {
+        maxRuleIdLength = Math.max(maxRuleIdLength, message.ruleId.length)
+      }
+      maxMsgLength = Math.max(maxMsgLength, message.message.length)
+    }
+  }
+
+  for (const result of results) {
+    const { filePath, messages } = result
+    const repoFilePath = relative(CI_PROJECT_DIR, filePath)
 
     for (const message of messages) {
-      let line;
-      line = messageIsLevelError(message) ? labelError : labelWarn;
-      line += String(message.ruleId ? message.ruleId : '').padEnd(stats.maxRuleIdLength + 2);
-      line += message.message.padEnd(stats.maxMsgLength + 2);
+      let line = message.fatal ? labelFatal : message.severity === 1 ? labelWarn : labelError
+      line += String(message.ruleId || '').padEnd(maxRuleIdLength + 2)
+      line += message.message.padEnd(maxMsgLength + 2)
 
       if (gitLabBaseURL) {
         // Create link to referenced file in GitLab
-        const anchor = message.line === undefined ? '' : `#L${message.line}`;
-        line += chalk.blue(`${gitLabBaseURL}${repoFilePath}${anchor}`);
+        let anchor = `#L${message.line}`
+        if (message.endLine != null && message.endLine !== message.line) {
+          anchor += `-${message.endLine}`
+        }
+        line += chalk.blue(`${gitLabBaseURL}${repoFilePath}${anchor}`)
       } else {
-        line += `${filePath}:${message.line || 0}:${message.column || 0}`;
+        line += `${filePath}:${message.line}:${message.column}`
       }
 
-      lines.push(line);
+      lines.push(line)
     }
   }
 
-  if (stats.total > 0) {
-    const details = `(${plural(stats.errors, 'error')}, ${plural(stats.warnings, 'warning')})`;
-    lines.push('', `${chalk.red('✖')} ${plural(stats.total, 'problem')} ${details}`);
+  const total = warnings + errors + fatal
+  if (total > 0) {
+    const details = `(${fatal} fatal, ${plural(errors, 'error')}, ${plural(warnings, 'warning')})`
+    lines.push('', `${chalk.red('✖')} ${plural(total, 'problem')} ${details}`)
   } else {
-    lines.push(`${chalk.green('✔')} No problems found`);
+    lines.push(`${chalk.green('✔')} No problems found`)
   }
 
-  lines.push('');
-  return lines.join(EOL);
+  lines.push('')
+  return lines.join(EOL)
 }
 
-module.exports = (results) => {
-  if (GITLAB_CI === 'true' && NODE_ENV !== 'test') {
-    chalk.level = 1;
+/**
+ * @param {LintResult[]} results The ESLint report results.
+ * @param {LintResultData} data The ESLint report result data.
+ */
+module.exports = (results, data) => {
+  /* c8 ignore start */
+  if (GITLAB_CI === 'true') {
+    chalk.level = 1
   }
+
+  /* c8 ignore stop */
   if (CI_JOB_NAME || ESLINT_CODE_QUALITY_REPORT) {
-    const data = convert(results);
-    const outputPath = ESLINT_CODE_QUALITY_REPORT || getOutputPath();
-    const dir = dirname(outputPath);
-    mkdirSync(dir, { recursive: true });
-    writeFileSync(outputPath, JSON.stringify(data, null, 2));
+    const issues = convert(results, data)
+    const outputPath = ESLINT_CODE_QUALITY_REPORT || getOutputPath()
+    const dir = dirname(outputPath)
+    mkdirSync(dir, { recursive: true })
+    writeFileSync(outputPath, JSON.stringify(issues, null, 2))
   }
 
-  return gitlabConsoleFormatter(results);
-};
+  return gitlabConsoleFormatter(results)
+}

package/package.json

@@ -1,22 +1,19 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "3.0.0",
+  "version": "5.0.0",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
   "license": "MIT",
   "homepage": "https://gitlab.com/remcohaszing/eslint-formatter-gitlab#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://gitlab.com/remcohaszing/eslint-formatter-gitlab.git"
-  },
-  "bugs": {
-    "url": "https://gitlab.com/remcohaszing/eslint-formatter-gitlab.git/issues"
-  },
+  "repository": "gitlab:remcohaszing/eslint-formatter-gitlab",
+  "funding": "https://github.com/sponsors/remcohaszing",
+  "bugs": "https://gitlab.com/remcohaszing/eslint-formatter-gitlab/-/issues",
+  "exports": "./index.js",
   "files": [
     "index.js"
   ],
   "scripts": {
-    "test": "jest"
+    "test": "c8 node --test --test-reporter @reporters/junit --test-reporter-destination=junit.xml --test-reporter spec --test-reporter-destination stdout"
   },
   "keywords": [
     "eslint",
@@ -27,28 +24,22 @@
   ],
   "dependencies": {
     "chalk": "^4.0.0",
-    "js-yaml": "^4.0.0"
+    "yaml": "^2.0.0"
   },
   "peerDependencies": {
     "eslint": "^5 || ^6 || ^7 || ^8"
   },
   "devDependencies": {
-    "codecov": "^3.0.0",
-    "eslint": "^7.0.0",
-    "eslint-config-remcohaszing": "^3.0.0",
-    "eslint-plugin-eslint-comments": "^3.0.0",
-    "eslint-plugin-import": "^2.0.0",
-    "eslint-plugin-jest": "^24.0.0",
-    "eslint-plugin-jest-formatting": "^3.0.0",
-    "eslint-plugin-jsdoc": "^36.0.0",
-    "eslint-plugin-markdown": "^2.0.0",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-sort-destructure-keys": "^1.0.0",
-    "eslint-plugin-unicorn": "^36.0.0",
-    "jest": "^27.0.0",
-    "jest-junit": "^13.0.0",
-    "memfs": "^3.0.0",
-    "prettier": "^2.0.0"
+    "@reporters/junit": "^1.0.0",
+    "@types/eslint": "^8.0.0",
+    "@types/node": "^20.0.0",
+    "c8": "^8.0.0",
+    "codeclimate-types": "^0.3.0",
+    "eslint": "^8.0.0",
+    "eslint-config-remcohaszing": "^9.0.0",
+    "prettier": "^2.0.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-remcohaszing": "^1.0.0",
+    "typescript": "^5.0.0"
   }
 }