linter-bundle 2.10.1 → 2.12.0

package/CHANGELOG.md

@@ -6,9 +6,54 @@ 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.12.0...HEAD)
 
-## [2.10.1] - 2020.03.11
+## [2.12.0] - 2022.03.30
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `5.14.0` to `5.17.0`
+- [eslint] Updated `eslint` from `8.11.0` to `8.12.0`
+- [eslint] Updated `eslint-import-resolver-typescript` from `2.5.0` to `2.7.0`
+- [eslint] Updated `eslint-plugin-jest` from `26.1.1` to `26.1.3`
+- [eslint] Updated `eslint-plugin-jsdoc` from `38.0.2` to `38.1.4`
+- [eslint] Updated `eslint-plugin-react` from `7.29.3` to `7.29.4`
+- [eslint] Updated `eslint-plugin-react-hooks` from `4.3.0` to `4.4.0`
+- [eslint] Updated `eslint-plugin-unicorn` from `41.0.0` to `41.0.1`
+- [stylelint] Updated `stylelint` from `14.5.3` to `14.6.1`
+- [stylelint] Updated `stylelint-scss` from `4.1.0` to `4.2.0`
+- Updated `micromatch` from `4.0.4` to `4.0.5`
+- [eslint] Make use of [`destructuredArrayIgnorePattern`](https://eslint.org/docs/rules/no-unused-vars#destructuredarrayignorepattern) of `@typescript-eslint/no-unused-vars` rule, to ignore variables with leading underscore.
+- [stylelint] Make use of [`declaration-property-max-values`](https://stylelint.io/user-guide/rules/list/declaration-property-max-values/) rule, and set `unprefixed-property-name` to `4`
+- [stylelint] Replace `function-no-unknown` by `scss/function-no-unknown`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.11.1...v2.12.0)
+
+## [2.11.1] - 2022.03.13
+
+### Changed
+
+- [eslint] Disabled `@typescript-eslint/no-redundant-type-constituents`, because of false positives with `Promise<... | never>`
+- [eslint] Weaken `@typescript-eslint/naming-convention` rule to allow names with special characters for `objectLiteralProperty`.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.11.0...v2.11.1)
+
+## [2.11.0] - 2022.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] Updated `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] - 2022.03.11
 
 ### Fixed
 
@@ -23,7 +68,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/README.md

@@ -168,7 +168,7 @@ module.exports = {
 Source | Description | Rules setup
 -|-|-
 `linter-bundle/eslint` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.js)
-`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby)
+`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
 `linter-bundle/eslint/overrides-javascript` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.js)
 `linter-bundle/eslint/overrides-javascript-lazy` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.js)
 `linter-bundle/eslint/overrides-jest` | Settings for projects using Jest. | [View](./eslint/overrides-jest.js)

package/eslint/index.js

@@ -561,10 +561,29 @@ module.exports = {
 			},
 			{
 				selector: 'objectLiteralProperty',
+				// `__html` is a property of React's `dangerouslySetInnerHTML` object
 				filter: '^__html$',
 				types: ['string'],
 				format: null
 			},
+			{
+				// Allow properties which only contain digits
+				selector: 'objectLiteralProperty',
+				filter: '^\\d+$',
+				format: null
+			},
+			{
+				// Allow empty or one-character properties
+				selector: 'objectLiteralProperty',
+				filter: '^.?$',
+				format: null
+			},
+			{
+				// Allow properties which which don't contain an underscore (to prevent usage of "UPPER_CASE") and contain atleast 4 characters
+				selector: 'objectLiteralProperty',
+				filter: '^[^_]{4,}$',
+				format: null
+			},
 			{ selector: 'typeProperty', format: ['camelCase', 'PascalCase'] },
 			{
 				selector: 'typeProperty',
@@ -641,7 +660,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-redundant-type-constituents': 'off', // False positive with Promise<... | never>
 		'@typescript-eslint/no-require-imports': 'error',
 		'@typescript-eslint/no-shadow': 'error',
 		'@typescript-eslint/no-this-alias': 'error',
@@ -670,7 +689,7 @@ module.exports = {
 		'@typescript-eslint/no-unsafe-member-access': 'error',
 		'@typescript-eslint/no-unsafe-return': 'error',
 		'@typescript-eslint/no-unused-expressions': 'error',
-		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_' }],
 		'@typescript-eslint/no-use-before-define': ['error', { functions: false }],
 		'@typescript-eslint/no-useless-constructor': 'error',
 		'@typescript-eslint/no-var-requires': 'error',
@@ -969,7 +988,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.12.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -39,29 +39,29 @@
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.14.0",
-		"@typescript-eslint/parser": "5.14.0",
-		"eslint": "8.10.0",
-		"eslint-import-resolver-typescript": "2.5.0",
+		"@typescript-eslint/eslint-plugin": "5.17.0",
+		"@typescript-eslint/parser": "5.17.0",
+		"eslint": "8.12.0",
+		"eslint-import-resolver-typescript": "2.7.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-jest": "26.1.3",
+		"eslint-plugin-jsdoc": "38.1.4",
 		"eslint-plugin-jsx-a11y": "6.5.1",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.0.0",
-		"eslint-plugin-react": "7.29.3",
-		"eslint-plugin-react-hooks": "4.3.0",
-		"eslint-plugin-unicorn": "41.0.0",
+		"eslint-plugin-react": "7.29.4",
+		"eslint-plugin-react-hooks": "4.4.0",
+		"eslint-plugin-unicorn": "41.0.1",
 		"markdownlint-cli": "0.31.1",
-		"micromatch": "4.0.4",
+		"micromatch": "4.0.5",
 		"postcss-scss": "4.0.3",
-		"stylelint": "14.5.3",
+		"stylelint": "14.6.1",
 		"stylelint-declaration-block-no-ignored-properties": "2.5.0",
 		"stylelint-order": "5.0.0",
-		"stylelint-scss": "4.1.0",
+		"stylelint-scss": "4.2.0",
 		"stylelint-selector-no-empty": "1.0.8",
 		"stylelint-use-logical-spec": "3.2.2"
 	},
@@ -72,8 +72,8 @@
 	"devDependencies": {
 		"@types/eslint": "8.4.1",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "17.0.21",
-		"stylelint-find-new-rules": "3.0.4",
-		"typescript": "4.6.2"
+		"@types/node": "17.0.23",
+		"stylelint-find-new-rules": "4.0.0",
+		"typescript": "4.6.3"
 	}
 }

package/stylelint/index.js

@@ -157,6 +157,7 @@ module.exports = {
 				]
 			}
 		],
+		'declaration-property-max-values': [true, { 'unprefixed-property-name': 4 }],
 		'declaration-no-important': [true, {
 			severity: 'warning'
 		}],
@@ -183,7 +184,7 @@ module.exports = {
 		'function-linear-gradient-no-nonstandard-direction': true,
 		'function-max-empty-lines': 0,
 		'function-name-case': 'lower',
-		'function-no-unknown': null, // @todo Create issue for false positives for "color.scale". Need this be covered by the `ignoreFunctions` option?
+		'function-no-unknown': null, // Implemented by scss/function-no-unknown
 		'function-parentheses-newline-inside': 'always-multi-line',
 		'function-parentheses-space-inside': 'never-single-line',
 		'function-url-no-scheme-relative': true,
@@ -890,6 +891,7 @@ module.exports = {
 		'scss/double-slash-comment-inline': null,
 		'scss/double-slash-comment-whitespace-inside': 'always',
 		'scss/function-color-relative': true,
+		'scss/function-no-unknown': true,
 		'scss/function-quote-no-quoted-strings-inside': true,
 		'scss/function-unquote-no-unquoted-strings-inside': true,
 		'scss/map-keys-quotes': 'always',