linter-bundle 3.1.0 → 3.3.0

package/CHANGELOG.md

@@ -6,17 +6,59 @@ 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/v3.1.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.3.0...HEAD)
+
+## [3.3.0] - 2023-07-13
+
+### Changed
+
+- [general] Drop support for Node.js version v17 (v16 is still supported), as `@typescript-eslint` v6.0.0 doesn't support it anymore
+- [eslint] Updated `@typescript-eslint` from `5.59.9` to `6.0.0`
+- [eslint] Updated `eslint` from `8.42.0` to `8.44.0`
+- [eslint] Updated `eslint-plugin-jest` from `27.2.1` to `27.2.3`
+- [eslint] Updated `eslint-plugin-n` from `16.0.0` to `16.0.1`
+- [eslint/overrides-jsdoc] Updated `eslint-plugin-jsdoc` from `46.2.4` to `46.4.3`
+- [markdownlint] Updated `markdownlint-cli` from `0.34.0` to `0.35.0`
+- [stylelint] Updated `stylelint` from `15.7.0` to `15.10.1`
+- [stylelint] Updated `stylelint-scss` from `5.0.0` to `5.0.1`
+- [eslint/overrides-jsdoc] Don't enforce line-breaks before `@throws` by the [`jsdoc/tag-lines`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-tag-lines) rule
+- [stylelint] Forked [`stylelint-selector-no-empty`](https://github.com/ssivanatarajan/stylelint-selector-no-empty), because it seems not to be regularly maintained anymore
+
+### Added
+
+- [stylelint] Make use of new [`media-feature-name-value-no-unknown`](https://github.com/stylelint/stylelint/blob/main/lib/rules/media-feature-name-value-no-unknown/README.md) rule
+- [stylelint] Make use of new [`media-query-no-invalid`](https://github.com/stylelint/stylelint/blob/main/lib/rules/media-query-no-invalid/README.md) rule
+- [eslint/overrides-javascript] Activated `@typescript-eslint/prefer-nullish-coalescing` for JavaScript file, as it is now supported in Node.js for a while.
+- [eslint/overrides-javascript] Activated `@typescript-eslint/prefer-optional-chain` for JavaScript file, as it is now supported in Node.js for a while.
+
+### Removed
+
+- [eslint] Remove silently removed `@typescript-eslint/no-parameter-properties` rule
+- [eslint] Disabled `unicorn/no-empty-file`, because of [false-positives](https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2175) with `@typescript-eslint v6.0.0`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.2.0...v3.3.0)
+
+## [3.2.0] - 2023-06-06
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `5.59.8` to `5.59.9`
+- [stylelint] Updated `stylelint` from `15.6.3` to `15.7.0`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.1.0...v3.2.0)
 
 ## [3.1.0] - 2023-06-05
 
 ### Changed
 
 - [eslint] Disabled [`unicorn/prefer-blob-reading-methods`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-blob-reading-methods.md) rule, as it's not widely supported yet
-- [eslint] Updated `@typescript-eslint/utils` from `5.59.6` to `5.59.8`
+- [eslint] Updated `@typescript-eslint` from `5.59.6` to `5.59.8`
 - [eslint] Updated `eslint` from `8.40.0` to `8.42.0`
 - [eslint] Updated `eslint-plugin-jsdoc` from `44.2.4` to `46.2.4`
 - [stylelint] Updated `stylelint` from `15.6.1` to `15.6.3`
+
+### Added
+
 - [eslint/overrides-jsdoc] Added, but disabled new [`jsdoc/imports-as-dependencies`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md) rule, as it doesn't cover `peerDependencies` and Node.js modules (like `child_process`)
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.0.0...v3.1.0)
@@ -47,7 +89,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Changed
 
-- [eslint] Updated `@typescript-eslint/utils` from `5.59.0` to `5.59.2`
+- [eslint] Updated `@typescript-eslint` from `5.59.0` to `5.59.2`
 - [eslint] Updated `eslint-plugin-jsdoc` from `43.0.7` to `43.2.0`
 - [markdownlint] Updated `markdownlint-cli` from `0.33.0` to `0.34.0`
 - [stylelint] Updated `stylelint` from `15.5.0` to `15.6.1`

package/README.md

@@ -46,7 +46,7 @@ Beside that, the following additional rules are part of this bundle:
 - [stylelint-high-performance-animation](https://www.npmjs.com/package/stylelint-high-performance-animation) (Forked version)
 - [stylelint-order](https://www.npmjs.com/package/stylelint-order)
 - [stylelint-scss](https://www.npmjs.com/package/stylelint-scss)
-- [stylelint-selector-no-empty](https://www.npmjs.com/package/stylelint-selector-no-empty)
+- [stylelint-selector-no-empty](https://www.npmjs.com/package/stylelint-selector-no-empty) (Forked version)
 - [stylelint-selector-tag-no-without-class](https://www.npmjs.com/package/stylelint-selector-tag-no-without-class) (Forked version)
 - [stylelint-use-logical-spec](https://www.npmjs.com/package/stylelint-use-logical-spec)
 

package/eslint/index.js

@@ -699,7 +699,6 @@ module.exports = {
 				'@typescript-eslint/no-namespace': ['error', { allowDeclarations: true }],
 				'@typescript-eslint/no-non-null-assertion': 'error',
 				'@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': 'off', // False positive with Promise<... | never>
 				'@typescript-eslint/no-require-imports': 'error',
@@ -953,7 +952,7 @@ module.exports = {
 				'unicorn/no-await-expression-member': 'error',
 				'unicorn/no-console-spaces': 'error',
 				'unicorn/no-document-cookie': 'error',
-				'unicorn/no-empty-file': 'error',
+				'unicorn/no-empty-file': 'off', // @todo False-positives since @typescript-eslint v6.0.0. @see https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2175
 				'unicorn/no-for-loop': 'off', // @typescript-eslint/prefer-for-of
 				'unicorn/no-hex-escape': 'error',
 				'unicorn/no-instanceof-array': 'error',

package/eslint/overrides-javascript.js

@@ -32,8 +32,6 @@ module.exports = {
 				'@typescript-eslint/no-require-imports': 'off', // Requires type information
 				'@typescript-eslint/no-unsafe-assignment': 'off', // @todo Reactivate after bug in @typescript-eslint is fixed (@see https://github.com/typescript-eslint/typescript-eslint/issues/1943)
 				'@typescript-eslint/no-var-requires': 'off', // Requires type information
-				'@typescript-eslint/prefer-nullish-coalescing': 'off', // @todo `??` is not yet supported by NodeJS. Remove this like, as soon as it is supported.
-				'@typescript-eslint/prefer-optional-chain': 'off', // @todo `?.` is not yet supported by NodeJS. Remove this like, as soon as it is supported.
 				'@typescript-eslint/triple-slash-reference': 'off', // Required to make use of *.d.ts files
 
 				/**

package/eslint/overrides-jsdoc.js

@@ -34,7 +34,7 @@ module.exports = {
 				'jsdoc/check-values': 'error',
 				'jsdoc/empty-tags': 'error',
 				'jsdoc/implements-on-classes': 'error',
-				'jsdoc/imports-as-dependencies': 'off', // @todo Doesn't cover `peerDependencies` and Node.js modules (like `child_process`) yet
+				'jsdoc/imports-as-dependencies': 'off', // @todo Doesn't cover `peerDependencies` yet. As of v46.2.5 it should cover Node.js modules (like `child_process`), which must be checked, before activation.
 				'jsdoc/match-description': 'error',
 				'jsdoc/match-name': 'off',
 				'jsdoc/multiline-blocks': ['error', { noSingleLineBlocks: true, singleLineTags: ['lends', 'type', 'typedef'], noFinalLineText: false }],
@@ -75,7 +75,8 @@ module.exports = {
 						param: { lines: 'never' },
 						private: { lines: 'never' },
 						protected: { lines: 'never' },
-						public: { lines: 'never' }
+						public: { lines: 'never' },
+						throws: { lines: 'never' }
 					},
 					startLines: null,
 					endLines: null,

package/eslint/rules/no-unnecessary-typeof.js

@@ -6,6 +6,7 @@
 
 const ts = require('typescript');
 
+// @ts-expect-error -- TypeScript is not able to resolve the folder since @typescript-eslint v6.0.0
 const { ESLintUtils } = require('@typescript-eslint/utils');
 
 /**
@@ -28,11 +29,9 @@ module.exports = {
 					return;
 				}
 
-				// @ts-expect-error -- Different type definitions for `Rule.RuleContext` in ESLint and @typescript-eslint
 				const parserServices = ESLintUtils.getParserServices(context);
 				const checker = parserServices.program.getTypeChecker();
 
-				// @ts-expect-error -- ESLint `Identifier` is not recognized as `Node` by @typescript-eslint
 				const originalNode = parserServices.esTreeNodeToTSNodeMap.get(node.argument);
 
 				/** @type {Type} */

package/lint.js

@@ -118,7 +118,7 @@ void (async () => {
 				return runTask({
 					taskName,
 					config,
-					command: `node "${require.resolve('stylelint/bin/stylelint.js')}" ${includes} --formatter unix`
+					command: `node "${path.join(path.dirname(require.resolve('stylelint')), '../bin/stylelint.js')}" ${includes} --formatter unix`
 				});
 			}
 
@@ -280,7 +280,7 @@ function validateEnvironment (npmOrYarn) {
 			propertyName = 'resolutions';
 		}
 		else {
-			installCommand = 'npm install';
+			installCommand = 'npm install --no-package-lock';
 			propertyName = 'overrides';
 		}
 
@@ -288,7 +288,7 @@ function validateEnvironment (npmOrYarn) {
 		process.stderr.write(`- ${missingOverrides.map((dependency) => `${dependency.name}: ${dependency.configuredVersion} is installed, but ${dependency.expectedVersion} is expected`).join('\n- ')}\n\n`);
 		process.stderr.write(`This could be caused by forgetting to execute \`${installCommand}\` after changing a version number in the package.json, or by some other package shipping outdated versions of the ${missingOverrides.length === 1 ? 'dependency' : 'dependencies'}.\n`);
 		process.stderr.write('If another package is causing this problem, you can fix it by adding the following entry to your package.json:\n');
-		process.stderr.write(`{\n  "${propertyName}: {\n    ${missingOverrides.map((dependency) => `"${dependency.name}": "${dependency.expectedVersion}"`).join(',\n    ')}\n  }\n}\n\n`);
+		process.stderr.write(`{\n  "${propertyName}": {\n    ${missingOverrides.map((dependency) => `"${dependency.name}": "${dependency.expectedVersion}"`).join(',\n    ')}\n  }\n}\n\n`);
 
 		process.exitCode = 1;
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "3.1.0",
+	"version": "3.3.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -22,7 +22,7 @@
 		"lint": "lint.js"
 	},
 	"engines": {
-		"node": ">=16.0.0"
+		"node": "^16.0.0 || >=18.0.0"
 	},
 	"repository": {
 		"type": "git",
@@ -40,31 +40,30 @@
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.59.8",
-		"@typescript-eslint/parser": "5.59.8",
-		"@typescript-eslint/utils": "5.59.8",
-		"eslint": "8.42.0",
+		"@typescript-eslint/eslint-plugin": "6.0.0",
+		"@typescript-eslint/parser": "6.0.0",
+		"@typescript-eslint/utils": "6.0.0",
+		"eslint": "8.44.0",
 		"eslint-import-resolver-typescript": "3.5.5",
 		"eslint-import-resolver-webpack": "0.13.2",
 		"eslint-plugin-eslint-comments": "3.2.0",
 		"eslint-plugin-functional": "5.0.8",
 		"eslint-plugin-import": "2.27.5",
-		"eslint-plugin-jest": "27.2.1",
-		"eslint-plugin-jsdoc": "46.2.4",
+		"eslint-plugin-jest": "27.2.3",
+		"eslint-plugin-jsdoc": "46.4.3",
 		"eslint-plugin-jsx-a11y": "6.7.1",
-		"eslint-plugin-n": "16.0.0",
+		"eslint-plugin-n": "16.0.1",
 		"eslint-plugin-promise": "6.1.1",
 		"eslint-plugin-react": "7.32.2",
 		"eslint-plugin-react-hooks": "4.6.0",
 		"eslint-plugin-unicorn": "47.0.0",
-		"markdownlint-cli": "0.34.0",
+		"markdownlint-cli": "0.35.0",
 		"micromatch": "4.0.5",
 		"postcss-scss": "4.0.6",
-		"stylelint": "15.6.3",
+		"stylelint": "15.10.1",
 		"stylelint-declaration-block-no-ignored-properties": "2.7.0",
 		"stylelint-order": "6.0.3",
-		"stylelint-scss": "5.0.0",
-		"stylelint-selector-no-empty": "1.0.9",
+		"stylelint-scss": "5.0.1",
 		"stylelint-use-logical-spec": "5.0.0"
 	},
 	"peerDependencies": {
@@ -72,10 +71,10 @@
 		"typescript": "^4.0.0"
 	},
 	"devDependencies": {
-		"@types/eslint": "8.40.0",
+		"@types/eslint": "8.44.0",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "20.2.5",
+		"@types/node": "20.4.2",
 		"stylelint-find-new-rules": "4.1.0",
-		"typescript": "5.1.3"
+		"typescript": "5.1.6"
 	}
 }

package/stylelint/index.js

@@ -15,9 +15,9 @@ module.exports = {
 		'stylelint-declaration-block-no-ignored-properties',
 		'stylelint-order',
 		'stylelint-scss',
-		'stylelint-selector-no-empty',
 		'stylelint-use-logical-spec',
 		path.join(__dirname, '/plugins/stylelint-high-performance-animation.js'),
+		path.join(__dirname, '/plugins/stylelint-selector-no-empty.js'),
 		path.join(__dirname, '/plugins/stylelint-selector-tag-no-without-class.js'),
 		path.join(__dirname, '/plugins/stylelint-stylistic.js')
 	],
@@ -187,7 +187,9 @@ module.exports = {
 		'media-feature-name-no-vendor-prefix': null, // For Safari, we still need "-webkit-min-device-pixel-ratio": https://caniuse.com/css-media-resolution
 		'media-feature-name-unit-allowed-list': null,
 		'media-feature-name-value-allowed-list': null,
+		'media-feature-name-value-no-unknown': true,
 		'media-feature-range-notation': 'prefix',
+		'media-query-no-invalid': true,
 		'named-grid-areas-no-invalid': true,
 		'no-descending-specificity': null, // doesn't work in many cases (e.g. while using the SCSS :global()-pseudo-class)
 		'no-duplicate-at-import-rules': true,

package/stylelint/plugins/stylelint-selector-no-empty.js

@@ -0,0 +1,114 @@
+/**
+ * @file Fork of `stylelint-selector-no-empty` rule.
+ *
+ * @license MIT
+ *
+ * @see https://www.npmjs.com/package/stylelint-selector-no-empty
+ */
+
+const stylelint = require('stylelint');
+
+const ruleName = 'plugin/stylelint-selector-no-empty';
+
+let nearestSelector = '';
+
+const messages = stylelint.utils.ruleMessages(ruleName, {
+	expected (selector) {
+		if (typeof selector === 'string' && selector.length > 0) {
+			return `Unexpected empty selector near '${selector}'`;
+		}
+
+		return 'Unexpected empty selector';
+	}
+});
+
+// @ts-expect-error -- Parameter 'enabled' implicitly has an 'any' type.
+module.exports = stylelint.createPlugin(ruleName, (enabled) => {
+	if (!enabled) {
+		return;
+	}
+
+	return (root, result) => {
+		root.walkRules((rule) => {
+			try {
+				nearestSelector = '';
+
+				for (const selector of rule.selector.split(',')) {
+					if (selector.length === 0) {
+						reportError(rule, result);
+						continue;
+					}
+					nearestSelector = selector;
+
+					const tabSplittedSelectors = getSplittedSelectors(selector.split('\n'), '\t');
+					const spaceSplittedSelectors = getSplittedSelectors(tabSplittedSelectors, ' ');
+					checkEmptySelector(spaceSplittedSelectors, result, rule);
+				}
+			}
+			catch { /* Do nothing */ }
+		});
+	};
+});
+
+/**
+ * Splits the selectors based on a specified delimiter and filters out empty selectors.
+ *
+ * @param {string[]} splittedSelectors - The selectors to be split.
+ * @param {string} splitBy - The delimiter to split the selectors.
+ * @returns {string[]} The split and filtered selectors.
+ */
+function getSplittedSelectors (splittedSelectors, splitBy) {
+	const res = [];
+
+	for (const splittedSelector of splittedSelectors) {
+		try {
+			for (const selector of splittedSelector.split(splitBy)) {
+				if (selector.trim().length > 0) {
+					res.push(selector);
+				}
+			}
+		}
+		catch { /* Do nothing */ }
+	}
+
+	return res;
+}
+
+/**
+ * Checks for empty selectors within the space-split selectors.
+ *
+ * @param {string[]} spaceSplittedSelectors - The space-split selectors.
+ * @param {stylelint.PostcssResult} result - The result object.
+ * @param {import('postcss').Rule} rule - The current rule.
+ */
+function checkEmptySelector (spaceSplittedSelectors, result, rule) {
+	for (let sp of spaceSplittedSelectors) {
+		if ((sp.startsWith('.') || sp.startsWith('#')) && sp.trim().length > 1) {
+			sp = sp.slice(1);
+		}
+
+		for (const classSelectorsWithoutDot of sp.split('.')) {
+			for (const selector of classSelectorsWithoutDot.split('#')) {
+				if (selector.trim().length === 0) {
+					reportError(rule, result);
+					return;
+				}
+			}
+		}
+	}
+}
+
+/**
+ * Reports an error for an empty selector.
+ *
+ * @param {import('postcss').Rule} rule - The current rule.
+ * @param {stylelint.PostcssResult} result - The result object.
+ */
+function reportError (rule, result) {
+	stylelint.utils.report({
+		result,
+		ruleName,
+		message: messages.expected(nearestSelector),
+		node: rule
+	});
+}

package/.gitattributes

@@ -1,16 +0,0 @@
-* text=auto
-
-*.css text eol=lf
-*.html text eol=lf
-*.js text eol=lf
-*.json text eol=lf
-*.log text eol=lf
-*.md text eol=lf
-*.scss text eol=lf
-*.svg text eol=lf
-*.ts text eol=lf
-*.tsx text eol=lf
-*.txt text eol=lf
-*.xml text eol=lf
-*.yaml text eol=lf
-*.yml text eol=lf

package/validate-stylelint-options.js

@@ -1,52 +0,0 @@
-/**
- * @file Ensures that stylelint options are valid by checking the `invalidOptionWarnings` property of the JSON response.
- */
-
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-
-const { runProcess } = require('./helper/run-process.js');
-
-void (async () => {
-	const temporaryPath = path.join(os.tmpdir(), 'linter-bundle-');
-
-	const folder = fs.mkdtempSync(temporaryPath);
-
-	const tempFilePath = path.join(folder, 'tmp.scss');
-
-	fs.writeFileSync(tempFilePath, '@property --color {\n\tsyntax: "<color>";\n\tinherits: false;\n\tinitial-value: #f00; // stylelint-disable-line color-no-hex -- The initial value must be a hex-color\n}\n\n* {\n\tborder: 1px solid var(--color);\n\n\tcolor: var(--color);\n}\n', 'utf8');
-
-	const result = await runProcess(`stylelint -f json "${tempFilePath}"`);
-
-	fs.unlinkSync(tempFilePath);
-
-	if (result.stderr) {
-		process.stderr.write(result.stderr);
-
-		process.exitCode = 1;
-
-		return;
-	}
-
-	/**
-	 * @type {import('stylelint').LintResult}
-	 */
-	const { invalidOptionWarnings, warnings } = JSON.parse(result.stdout)[0];
-
-	if (warnings.length > 0) {
-		process.stderr.write(`Warnings:\n\n- ${warnings.map(({ text }) => text).join('\n- ')}\n`);
-
-		process.exitCode = 1;
-
-		return;
-	}
-
-	if (invalidOptionWarnings.length > 0) {
-		process.stderr.write(`Invalid stylelint configuration:\n\n- ${invalidOptionWarnings.map(({ text }) => text).join('\n- ')}\n`);
-
-		process.exitCode = 1;
-
-		return;
-	}
-})();