eslint-formatter-gitlab 2.2.0 → 3.0.0

package/README.md

@@ -44,7 +44,13 @@ 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. |
-| `ESLINT_FORMATTER`           | The ESLint formatter to use for the console output. This defaults to stylish, the default ESLint formatter.                                                    |
+
+## Upgrading
+
+### to v3
+
+- Support for the environment variable `ESLINT_FORMATTER` has been removed, console output now
+  always uses a builtin formatter.
 
 [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

package/index.js

@@ -1,16 +1,21 @@
 const { createHash } = require('crypto');
 const { existsSync, lstatSync, mkdirSync, readFileSync, writeFileSync } = require('fs');
+const { EOL } = require('os');
 const { dirname, join, relative, resolve } = require('path');
 
-const { CLIEngine } = require('eslint');
+// eslint-disable-next-line unicorn/import-style
+const chalk = require('chalk');
 const yaml = require('js-yaml');
 
 const {
   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,
-  ESLINT_FORMATTER,
+  GITLAB_CI,
+  NODE_ENV,
 } = process.env;
 
 /**
@@ -60,30 +65,118 @@ function createFingerprint(filePath, message) {
  * @returns {object[]} The ESLint messages in the form of a GitLab code quality report.
  */
 function convert(results) {
-  return results.reduce(
-    (acc, result) => [
-      ...acc,
-      ...result.messages.map((message) => {
-        const relativePath = relative(CI_PROJECT_DIR, result.filePath);
-        // https://github.com/codeclimate/spec/blob/master/SPEC.md#data-types
-        return {
-          description: message.message,
-          severity: message.severity === 2 ? 'major' : 'minor',
-          fingerprint: createFingerprint(relativePath, message),
-          location: {
-            path: relativePath,
-            lines: {
-              begin: message.line,
-            },
+  const messages = [];
+  for (const result of results) {
+    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({
+        description: message.message,
+        severity: message.severity === 2 ? 'major' : 'minor',
+        fingerprint: createFingerprint(relativePath, message),
+        location: {
+          path: relativePath,
+          lines: {
+            begin: message.line,
           },
-        };
-      }),
-    ],
-    [],
-  );
+        },
+      });
+    }
+  }
+  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
+ */
+function messageIsLevelError(message) {
+  return message.fatal || message.severity === 2;
+}
+
+/**
+ * @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.
+ * @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
+  const labelError = `${chalk.red('error')}  `;
+  const labelWarn = `${chalk.yellow('warn')}   `;
+
+  const lines = [''];
+
+  let gitLabBaseURL;
+  if (CI_PROJECT_URL && CI_COMMIT_SHORT_SHA) {
+    gitLabBaseURL = `${CI_PROJECT_URL}/-/blob/${CI_COMMIT_SHORT_SHA}/`;
+  }
+
+  const stats = calculateResultsStats(results);
+
+  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);
+
+      if (gitLabBaseURL) {
+        // Create link to referenced file in GitLab
+        const anchor = message.line === undefined ? '' : `#L${message.line}`;
+        line += chalk.blue(`${gitLabBaseURL}${repoFilePath}${anchor}`);
+      } else {
+        line += `${filePath}:${message.line || 0}:${message.column || 0}`;
+      }
+
+      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}`);
+  } else {
+    lines.push(`${chalk.green('✔')} No problems found`);
+  }
+
+  lines.push('');
+  return lines.join(EOL);
 }
 
 module.exports = (results) => {
+  if (GITLAB_CI === 'true' && NODE_ENV !== 'test') {
+    chalk.level = 1;
+  }
   if (CI_JOB_NAME || ESLINT_CODE_QUALITY_REPORT) {
     const data = convert(results);
     const outputPath = ESLINT_CODE_QUALITY_REPORT || getOutputPath();
@@ -91,9 +184,6 @@ module.exports = (results) => {
     mkdirSync(dir, { recursive: true });
     writeFileSync(outputPath, JSON.stringify(data, null, 2));
   }
-  let formatter = CLIEngine.getFormatter(ESLINT_FORMATTER);
-  if (formatter === module.exports) {
-    formatter = CLIEngine.getFormatter();
-  }
-  return formatter(results);
+
+  return gitlabConsoleFormatter(results);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
   "license": "MIT",
@@ -26,28 +26,29 @@
     "gitlab-ci"
   ],
   "dependencies": {
+    "chalk": "^4.0.0",
     "js-yaml": "^4.0.0"
   },
   "peerDependencies": {
-    "eslint": "^5 || ^6 || ^7"
+    "eslint": "^5 || ^6 || ^7 || ^8"
   },
   "devDependencies": {
-    "codecov": "^3.8.1",
-    "eslint": "^7.18.0",
-    "eslint-config-remcohaszing": "^3.1.0",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.1.3",
-    "eslint-plugin-jest-formatting": "^2.0.1",
-    "eslint-plugin-jsdoc": "^31.4.0",
-    "eslint-plugin-markdown": "^2.0.0-rc.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-sort-destructure-keys": "^1.3.5",
-    "eslint-plugin-unicorn": "^27.0.0",
-    "jest": "^26.6.3",
-    "jest-junit": "^12.0.0",
-    "memfs": "^3.2.0",
-    "prettier": "^2.2.1"
+    "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"
   }
 }

package/CHANGELOG.md

@@ -1,56 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
-adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.2.0] - 2021-01-27
-
-### Changed
-
-- Updated `ja-yaml`.
-
-## [2.2.0] - 2020-12-12
-
-### Added
-
-- Added severity to output.
-
-## [2.0.0] - 2020-04-14
-
-### Changed
-
-- Support ESLint 7.
-
-### Fixed
-
-- Fix infinite recursion when `ESLINT_CODE_QUALITY_REPORT` refers to `eslint-formatter-gitlab`
-  itself.
-
-## [1.1.0] - 2019-08-08
-
-### Changed
-
-- Support ESLint 6.
-
-## [1.0.2] - 2018-12-13
-
-### Fixes
-
-- Fix automated release process.
-
-## [1.0.1] - 2018-12-13
-
-### Added
-
-- Tests.
-- Link to example merge request.
-
-## [1.0.0] - 2018-11-29
-
-### Added
-
-- Initial release.