linter-bundle 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -6,7 +6,52 @@ 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.9.0...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
+
+### Fixed
+
+- [eslint/override-react] Fix naming `warnOnDuplicates` option of [`react/jsx-key`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-key.md) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.10.0...v2.10.1)
+
+## [2.10.0] - 2022.03.10
+
+### Changed
+
+- [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`
+- [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`
+
+### Added
+
+- [eslint] Make use of new [`@typescript-eslint/no-redundant-type-constituents`](https://typescript-eslint.io/rules/no-redundant-type-constituents/) rule
+- [eslint/override-react] Make use of new [`react/hook-use-state`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/hook-use-state.md) rule
+- [eslint/override-react] Set new `propElementValues` option to "always" for [`react/jsx-curly-brace-presence`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-brace-presence.md) rule
+- [eslint/override-react] Make use of new [`react/iframe-missing-sandbox`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/iframe-missing-sandbox.md) rule
+- [eslint/override-react] Make use of new `warnDuplicates` option of [`react/jsx-key`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-key.md) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.9.0...v2.10.0)
 
 ## [2.9.0] - 2022.02.23
 

package/TODO.md

@@ -1,5 +1,10 @@
 # @todo
 
+- Make git diff-branch configurable
+  on GitHub Actions this could be used:
+  - run: git diff --name-only -z origin/${GITHUB_BASE_REF}
+  Is there a variable with includes origin/ already?
+
 Some tools like Gatsby ship deprecated dependencies of eslint and @typescript-eslint.
 Since npm installs packages alphabetically, the outdated `gatsby` dependencies are installed in the `node_modules` root, instead of the newer `linter-bundle` dependencies. Since the old versions often do not support new rules or new options, this may cause linting to fail with errors like this:
 

package/eslint/index.js

@@ -641,6 +641,7 @@ module.exports = {
 		'@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
 		'@typescript-eslint/no-parameter-properties': 'error',
 		'@typescript-eslint/no-redeclare': ['error', { ignoreDeclarationMerge: true }],
+		'@typescript-eslint/no-redundant-type-constituents': 'error',
 		'@typescript-eslint/no-require-imports': 'error',
 		'@typescript-eslint/no-shadow': 'error',
 		'@typescript-eslint/no-this-alias': 'error',
@@ -968,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/eslint/overrides-react.js

@@ -66,6 +66,7 @@ module.exports = {
 					namedComponents: 'arrow-function',
 					unnamedComponents: 'arrow-function'
 				}],
+				'react/hook-use-state': 'error',
 				'react/no-access-state-in-setstate': 'error',
 				'react/no-array-index-key': 'error',
 				'react/no-arrow-function-lifecycle': 'error',
@@ -140,7 +141,7 @@ module.exports = {
 				'react/jsx-handler-names': 'off', // @todo There should be an option which checks if the function is used multiple times in a class (like this.closeTooltip()) - in that case, the 'handle' prefix should not be mandatory
 				'react/jsx-indent': ['error', 'tab', { checkAttributes: true, indentLogicalExpressions: true }],
 				'react/jsx-indent-props': ['error', 'tab'],
-				'react/jsx-key': ['error', { checkKeyMustBeforeSpread: true }],
+				'react/jsx-key': ['error', { checkKeyMustBeforeSpread: true, warnOnDuplicates: true }],
 				'react/jsx-max-depth': ['error', { max: 8 }],
 				'react/jsx-max-props-per-line': ['error', { maximum: { single: 5, multi: 1 } }],
 				'react/no-adjacent-inline-elements': 'off', // @todo There is an issue if inline and block elements are mixed. Simple example: `<span>Text</span><br />` here, the space between the SPAN and BR should not be forced, because a space at the end of a line does not make sense.
@@ -155,7 +156,7 @@ module.exports = {
 				'react/jsx-no-undef': 'error',
 				'react/jsx-no-useless-fragment': 'error',
 				'react/jsx-one-expression-per-line': ['off', { allow: 'single-child' }], // @todo Doesn't work with something like "Text <a href="...">Link</a> More Text", which should be valid
-				'react/jsx-curly-brace-presence': 'error',
+				'react/jsx-curly-brace-presence': ['error', { propElementValues: 'always' }],
 				'react/jsx-fragments': ['error', 'element'],
 				'react/jsx-pascal-case': ['error', { allowAllCaps: true }],
 				'react/jsx-props-no-multi-spaces': '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.9.0",
+	"version": "2.11.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -39,26 +39,26 @@
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.12.1",
-		"@typescript-eslint/parser": "5.12.1",
-		"eslint": "8.9.0",
+		"@typescript-eslint/eslint-plugin": "5.14.0",
+		"@typescript-eslint/parser": "5.14.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.4",
+		"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",
-		"eslint-plugin-react": "7.28.0",
+		"eslint-plugin-react": "7.29.3",
 		"eslint-plugin-react-hooks": "4.3.0",
 		"eslint-plugin-unicorn": "41.0.0",
 		"markdownlint-cli": "0.31.1",
 		"micromatch": "4.0.4",
 		"postcss-scss": "4.0.3",
-		"stylelint": "14.5.2",
+		"stylelint": "14.5.3",
 		"stylelint-declaration-block-no-ignored-properties": "2.5.0",
 		"stylelint-order": "5.0.0",
 		"stylelint-scss": "4.1.0",
@@ -72,8 +72,8 @@
 	"devDependencies": {
 		"@types/eslint": "8.4.1",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "17.0.19",
+		"@types/node": "17.0.21",
 		"stylelint-find-new-rules": "3.0.4",
-		"typescript": "4.5.5"
+		"typescript": "4.6.2"
 	}
 }

package/stylelint/index.js

@@ -873,7 +873,7 @@ module.exports = {
 		'scss/dollar-variable-empty-line-after': [
 			'always',
 			{
-				except: ['last-nested', 'before-comment', 'before-dollar-variable']
+				except: ['last-nested', 'before-dollar-variable']
 			}
 		],
 		'scss/dollar-variable-first-in-block': [true, { ignore: ['comments', 'imports'] }],

package/types.d.ts

@@ -10,6 +10,8 @@
  * @see https://stackoverflow.com/a/68452689/4449804
  */
 
+/* eslint-disable @typescript-eslint/naming-convention -- We have to follow the naming conventions of the Linter rules here. */
+
 // @ts-expect-error -- False-positive
 declare namespace globalThis {
 	// eslint-disable-next-line no-inner-declarations, vars-on-top, no-var -- False-positives