linter-bundle 2.10.1 → 2.11.0

package/CHANGELOG.md

@@ -6,7 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
-[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.10.1...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.11.0...HEAD)
+
+## [2.11.0] - 2020.03.12
+
+### Added
+
+- Ensures that the ["overrides"](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides) and ["resolutions"](https://classic.yarnpkg.com/en/docs/selective-version-resolutions/) configuration in the `package.json` is up-to-date for linter dependencies, to prevent errors with unknown
+  linter rules or options.
+
+### Changed
+
+- [eslint] Updated `eslint` from `8.10.0` to `8.11.0`
+- [eslint] Update `eslint-plugin-jsdoc` from `37.9.7` to `38.0.2`
+- [eslint] Disabled [`unicorn/prefer-json-parse-buffer`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-json-parse-buffer.md) rule, as [TypeScript states](https://github.com/microsoft/TypeScript/issues/11842) that string needs to be used as of the ES specification.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.10.1...v2.11.0)
 
 ## [2.10.1] - 2020.03.11
 
@@ -23,7 +38,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [stylelint] Remove `"before-comment"` exception in `scss/dollar-variable-empty-line-after` rule
 - [eslint] Updated `@typescript-eslint/eslint-plugin` from `5.12.1` to `5.14.0`
 - [eslint] Updated `@typescript-eslint/parser` from `5.12.1` to `5.14.0`
-- [eslint] Updated `eslint` from `8.9.0` to `8.10.0`jsx-key:
+- [eslint] Updated `eslint` from `8.9.0` to `8.10.0`
 - [eslint] Updated `eslint-plugin-jsdoc` from `37.9.4` to `37.9.7`
 - [eslint] Updated `eslint-plugin-react` from `7.28.0` to `7.29.3`
 - [stylelint] Updated `stylelint` from `14.5.2` to `14.5.3`

package/eslint/index.js

@@ -969,7 +969,7 @@ module.exports = {
 		'unicorn/prefer-dom-node-text-content': 'error',
 		'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
 		'unicorn/prefer-includes': 'error',
-		'unicorn/prefer-json-parse-buffer': 'error',
+		'unicorn/prefer-json-parse-buffer': 'off', // TypeScript states that string needs to be used as of the ES specification. @see https://github.com/microsoft/TypeScript/issues/11842
 		'unicorn/prefer-keyboard-event-key': 'error',
 		'unicorn/prefer-math-trunc': 'error',
 		'unicorn/prefer-modern-dom-apis': 'error',

package/helper/validate-package-overrides.js

@@ -0,0 +1,62 @@
+/**
+ * @file Ensures that the "overrides" and "resolutions" of the project where linter-bundle is used, match to the versions used in the linter-bundle itself.
+ *
+ * @see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides
+ * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+/** @typedef {{ name: string; configuredVersion: string; expectedVersion: string; }} Dependency */
+
+/**
+ * Detects outdated "overrides"/"resolutions" dependencies.
+ *
+ * @returns {{ overrides: Dependency[]; resolutions: Dependency[]; }} Either the input array, or an empty array, if the input array is not an array.
+ */
+function validatePackageOverrides () {
+	const linterBundleDependencies = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8')).dependencies;
+	const projectPackageJson = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8'));
+
+	const overrides = [];
+	const resolutions = [];
+
+	if (typeof projectPackageJson.overrides === 'object' && projectPackageJson.overrides !== null) {
+		for (const [name, version] of Object.entries(projectPackageJson.overrides)) {
+			if (!(name in linterBundleDependencies)) {
+				continue;
+			}
+
+			if (version !== linterBundleDependencies[name]) {
+				overrides.push({
+					name,
+					configuredVersion: version,
+					expectedVersion: linterBundleDependencies[name]
+				});
+			}
+		}
+	}
+
+	if (typeof projectPackageJson.resolutions === 'object' && projectPackageJson.resolutions !== null) {
+		for (const [name, version] of Object.entries(projectPackageJson.resolutions)) {
+			if (!(name in linterBundleDependencies)) {
+				continue;
+			}
+
+			if (version !== linterBundleDependencies[name]) {
+				resolutions.push({
+					name,
+					configuredVersion: version,
+					expectedVersion: linterBundleDependencies[name]
+				});
+			}
+		}
+	}
+
+	return { overrides, resolutions };
+}
+
+module.exports = {
+	validatePackageOverrides
+};

package/lint.js

@@ -11,6 +11,8 @@ const tty = require('tty');
 
 const micromatch = require('micromatch');
 
+const { validatePackageOverrides } = require('./helper/validate-package-overrides.js');
+
 /** @typedef {{ taskName: string; config: Partial<Record<string, (string | true)[]>>; }} TaskNameAndConfig */
 /** @typedef {TaskNameAndConfig & { command: string; options?: childProcess.ExecOptions; }} TaskSetup */
 /** @typedef {{ code: number; stdout: string; stderr: string; runtime: number; }} ProcessResult */
@@ -19,6 +21,22 @@ const micromatch = require('micromatch');
 const isTerminal = tty.isatty(1);
 
 void (async () => {
+	const outdatedOverrides = validatePackageOverrides();
+
+	if (outdatedOverrides.overrides.length > 0 || outdatedOverrides.resolutions.length > 0) {
+		if (outdatedOverrides.overrides.length > 0) {
+			process.stderr.write(`Outdated "overrides" in package.json detected:\n- ${outdatedOverrides.overrides.map((dependency) => `${dependency.name}: ${dependency.configuredVersion} is configured, but ${dependency.expectedVersion} is expected`).join('\n- ')}\n\n`);
+		}
+
+		if (outdatedOverrides.resolutions.length > 0) {
+			process.stderr.write(`Outdated "resolutions" in package.json detected:\n- ${outdatedOverrides.overrides.map((dependency) => `${dependency.name}: ${dependency.configuredVersion} is configured, but ${dependency.expectedVersion} is expected`).join('\n- ')}\n\n`);
+		}
+
+		process.exitCode = 1;
+
+		return;
+	}
+
 	/** @type {{ diff: Promise<ProcessResult>; modified: Promise<ProcessResult>; deleted: Promise<ProcessResult>; } | undefined} */
 	let gitFilesProcessPromise;
 	/** @type {string[] | undefined} */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "2.10.1",
+	"version": "2.11.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -41,14 +41,14 @@
 	"dependencies": {
 		"@typescript-eslint/eslint-plugin": "5.14.0",
 		"@typescript-eslint/parser": "5.14.0",
-		"eslint": "8.10.0",
+		"eslint": "8.11.0",
 		"eslint-import-resolver-typescript": "2.5.0",
 		"eslint-import-resolver-webpack": "0.13.2",
 		"eslint-plugin-eslint-comments": "3.2.0",
 		"eslint-plugin-functional": "4.2.0",
 		"eslint-plugin-import": "2.25.4",
 		"eslint-plugin-jest": "26.1.1",
-		"eslint-plugin-jsdoc": "37.9.7",
+		"eslint-plugin-jsdoc": "38.0.2",
 		"eslint-plugin-jsx-a11y": "6.5.1",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.0.0",