eslint-formatter-gitlab 1.1.0 → 3.0.0

package/README.md

@@ -4,7 +4,7 @@
 
 ## Requirements
 
-This requires at least GitLab Starter 11.5 and at least ESLint 5.
+This requires at least GitLab Bronze or Starter 11.5 and at least ESLint 5.
 
 ## Installation
 
@@ -20,7 +20,7 @@ _.gitlab-ci.yml_:
 
 ```yaml
 eslint:
-  image: node:10-alpine
+  image: node:14-alpine
   script:
     - npm ci
     - npx eslint --format gitlab .
@@ -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,42 +1,57 @@
-const crypto = require('crypto');
-const path = require('path');
+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');
-const fs = require('fs-extra');
-const isGlob = require('is-glob');
+// eslint-disable-next-line unicorn/import-style
+const chalk = require('chalk');
 const yaml = require('js-yaml');
 
 const {
-  // Used as a fallback for local testing.
   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;
 
+/**
+ * @returns {string} The output path of the code quality artifact.
+ */
 function getOutputPath() {
-  const jobs = yaml.load(fs.readFileSync(path.join(CI_PROJECT_DIR, CI_CONFIG_PATH), 'utf-8'));
+  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 == null) {
+  if (!location) {
     throw new Error(`${msg}, but no value was found.`);
   }
   if (Array.isArray(location)) {
-    throw new Error(`${msg}, but found an array instead.`);
-  }
-  if (typeof location !== 'string') {
-    throw new Error(`${msg}, but found ${JSON.stringify(location)} instead.`);
+    throw new TypeError(`${msg}, but found an array instead.`);
   }
-  if (isGlob(location)) {
-    throw new Error(`${msg}, but found a glob instead.`);
-  }
-  return path.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.
+ * @returns {string} The fingerprint for the ESLint report message.
+ */
 function createFingerprint(filePath, message) {
-  const md5 = crypto.createHash('md5');
+  const md5 = createHash('md5');
   md5.update(filePath);
   if (message.ruleId) {
     md5.update(message.ruleId);
@@ -45,37 +60,130 @@ function createFingerprint(filePath, message) {
   return md5.digest('hex');
 }
 
+/**
+ * @param {object[]} results - The ESLint report results.
+ * @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 = path.relative(CI_PROJECT_DIR, result.filePath);
-        // https://github.com/codeclimate/spec/blob/master/SPEC.md#data-types
-        return {
-          description: message.message,
-          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 => {
+module.exports = (results) => {
+  if (GITLAB_CI === 'true' && NODE_ENV !== 'test') {
+    chalk.level = 1;
+  }
   if (CI_JOB_NAME || ESLINT_CODE_QUALITY_REPORT) {
-    fs.outputJsonSync(ESLINT_CODE_QUALITY_REPORT || getOutputPath(), convert(results), {
-      spaces: 2,
-    });
+    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));
   }
-  return CLIEngine.getFormatter(ESLINT_FORMATTER)(results);
-};
 
-module.exports.getOutputPath = getOutputPath;
-module.exports.convert = convert;
+  return gitlabConsoleFormatter(results);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-formatter-gitlab",
-  "version": "1.1.0",
+  "version": "3.0.0",
   "description": "Show ESLint results directly in the GitLab code quality results",
   "author": "Remco Haszing <remcohaszing@gmail.com>",
   "license": "MIT",
@@ -16,7 +16,6 @@
     "index.js"
   ],
   "scripts": {
-    "prettier": "prettier --check '**/*.{json,md,yml}'",
     "test": "jest"
   },
   "keywords": [
@@ -27,24 +26,29 @@
     "gitlab-ci"
   ],
   "dependencies": {
-    "fs-extra": "^8.1.0",
-    "is-glob": "^4.0.1",
-    "js-yaml": "^3.13.1"
+    "chalk": "^4.0.0",
+    "js-yaml": "^4.0.0"
   },
   "peerDependencies": {
-    "eslint": "^5 || ^6"
+    "eslint": "^5 || ^6 || ^7 || ^8"
   },
   "devDependencies": {
-    "codecov": "^3.5.0",
-    "eslint": "^6.1.0",
-    "eslint-config-airbnb-base": "^13.2.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-jest": "^22.15.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "gitlab-npm-audit-parser": "^1.0.3",
-    "jest": "^24.8.0",
-    "jest-junit": "^7.0.0",
-    "prettier": "^1.18.2"
+    "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,33 +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]
-
-## [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.