linter-bundle 2.13.0 → 2.14.0

package/CHANGELOG.md

@@ -8,6 +8,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.13.0...HEAD)
 
+## [2.14.0] - 2022.05.05
+
+### Changed
+
+- [general] Remove files from npm package which are only necessary for development
+- [eslint] Updated `eslint-import-resolver-typescript` from `2.7.0` to `2.7.1`
+- [eslint] Updated `@typescript-eslint` from `5.21.0` to `5.22.0`
+- [eslint] Updated `eslint-plugin-jsdoc` from `39.2.8` to `39.2.9`
+- [eslint] Updated `eslint-plugin-react-hooks` from `4.4.0` to `4.5.0`
+- [stylelint] Updated `stylelint` from `14.7.1` to `14.8.2`
+- [eslint] Make use of new [`@typescript-eslint/no-duplicate-enum-values`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-duplicate-enum-values.md) rule
+- [stylelint] Make use of new [`keyframe-block-no-duplicate-selectors`](https://github.com/stylelint/stylelint/blob/main/lib/rules/keyframe-block-no-duplicate-selectors/README.md) rule
+- [stylelint] In the deployment process, ensure that the used Stylelint options are valid
+- [stylelint] Fix invalid configuration of [`declaration-property-max-values`](https://github.com/stylelint/stylelint/blob/main/lib/rules/declaration-property-max-values/README.md) rule
+
 ## [2.13.0] - 2022.04.25
 
 ### Changed
@@ -26,11 +41,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Activate `allowExpressions` option of [`@typescript-eslint/explicit-function-return-type`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-function-return-type.md) rule
 - [eslint/overrides-jsdoc] Set [`minLineCount` option to 2](https://github.com/gajus/eslint-plugin-jsdoc/issues/870) for `require-jsdoc` rule
 - [eslint] Reactivated the [`import/no-relative-packages`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-relative-packages.md) rule
-- [eslint] Make use of [`unicorn/no-useless-switch-case`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-useless-switch-case.md) rule
-- [eslint] Make use of [`unicorn/prefer-modern-math-apis`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-modern-math-apis.md) rule
-- [eslint] Make use of [`unicorn/no-unreadable-iife`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-unreadable-iife.md) rule
+- [eslint] Make use of new [`unicorn/no-useless-switch-case`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-useless-switch-case.md) rule
+- [eslint] Make use of new [`unicorn/prefer-modern-math-apis`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-modern-math-apis.md) rule
+- [eslint] Make use of new [`unicorn/no-unreadable-iife`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-unreadable-iife.md) rule
 - [eslint] Add but disable [`unicorn/prefer-native-coercion-functions`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-native-coercion-functions.md) rule, because this would produce inconsistency in the code and is harder to read
-- [stylelint] Set new [`selector-not-notation`](https://github.com/stylelint/stylelint/blob/main/lib/rules/selector-not-notation/README.md) rule to `"complex"`
+- [stylelint] Set [`selector-not-notation`](https://github.com/stylelint/stylelint/blob/main/lib/rules/selector-not-notation/README.md) rule to `"complex"`
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.12.0...v2.13.0)
 
@@ -48,7 +63,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.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`
+- [general] 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`
@@ -68,7 +83,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### 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
+- [general] 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
@@ -119,8 +134,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-- `--timing` argument to show information how long each linting process was running.
-- Experimental `--git` argument to only lint (ESLint, Stylelint and Markdownlint) files which have been detected as changed (compared to the upstream branch) by Git
+- [general] `--timing` argument to show information how long each linting process was running.
+- [general] Experimental `--git` argument to only lint (ESLint, Stylelint and Markdownlint) files which have been detected as changed (compared to the upstream branch) by Git
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.8.4...v2.9.0)
 
@@ -358,7 +373,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Changed
 
-- The minimum required Node.js version is v14 now
+- [general] The minimum required Node.js version is v14 now
 - [eslint] Updated `@typescript-eslint` from v4.31.0 to v4.31.1
 - [eslint] Updated `eslint-import-resolver-typescript` from v2.4.0 to v2.5.0
 - [eslint] Updated `eslint-plugin-jest` from v24.4.0 to v24.4.2
@@ -747,7 +762,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Changed
 
-- By default, the terminal output of the linters is printed only in case of failure to prevent unnecessary noise. Use `--verbose` to show their output even on success.
+- [general] By default, the terminal output of the linters is printed only in case of failure to prevent unnecessary noise. Use `--verbose` to show their output even on success.
 - [stylelint] Disallow reserved ECMAScript keywords (`abstract`, `arguments`, `await`, `boolean`, `break`, `byte`, `case`, `catch`, `char`, `class`, `const`, `continue`, `debugger`, `default`, `delete`, `do`, `double`, `else`, `enum`, `eval`, `export`, `extends`, `false`, `final`, `finally`,
   `float`, `for`, `function`, `goto`, `if`, `implements`, `import`, `in`, `Infinity`, `instanceof`, `int`, `interface`, `let`, `long`, `NaN`, `native`, `new`, `null`, `package`, `private`, `protected`, `public`, `return`, `short`, `static`, `super`, `switch`, `synchronized`, `this`, `throw`,
   `throws`, `transient`, `true`, `try`, `typeof`, `undefined`, `var`, `void`, `volatile`, `while`, `with`, and `yield`) as class names

package/eslint/index.js

@@ -628,6 +628,7 @@ module.exports = {
 		'@typescript-eslint/no-confusing-non-null-assertion': 'error',
 		'@typescript-eslint/no-confusing-void-expression': ['error', { ignoreArrowShorthand: true, ignoreVoidOperator: true }],
 		'@typescript-eslint/no-dupe-class-members': 'error',
+		'@typescript-eslint/no-duplicate-enum-values': 'error',
 		'@typescript-eslint/no-duplicate-imports': 'error',
 		'@typescript-eslint/no-dynamic-delete': 'error',
 		'@typescript-eslint/no-empty-function': 'error',

package/helper/run-process.js

@@ -0,0 +1,47 @@
+/**
+ * @file Executes a process asynchronously.
+ */
+
+/** @typedef {{ code: number; stdout: string; stderr: string; runtime: number; }} ProcessResult */
+
+const childProcess = require('child_process');
+
+/**
+ * Executes a process asynchronously.
+ *
+ * @param {string} command - The process to execute.
+ * @param {childProcess.ExecOptions | undefined} [options] - The options of the `childProcess.exec()` method.
+ * @returns {Promise<ProcessResult>} An object containing the result of the process execution
+ */
+async function runProcess (command, options) {
+	return new Promise((resolve) => {
+		const startTimestamp = performance.now();
+
+		/** @type {string[]} */
+		const stdout = [];
+
+		/** @type {string[]} */
+		const stderr = [];
+
+		const lintingProcess = childProcess.exec(command, options);
+
+		lintingProcess.stdout?.on('data', (/** @type {string} */data) => {
+			stdout.push(data);
+		});
+
+		lintingProcess.stderr?.on('data', (/** @type {string} */data) => {
+			stderr.push(data);
+		});
+
+		lintingProcess.on('exit', (code) => resolve({
+			code: code ?? 0,
+			stdout: stdout.join(''),
+			stderr: stderr.join(''),
+			runtime: performance.now() - startTimestamp
+		}));
+	});
+}
+
+module.exports = {
+	runProcess
+};

package/lint.js

@@ -4,18 +4,18 @@
  * @file Entry point of the linter-bundle.
  */
 
-const childProcess = require('child_process');
 const fs = require('fs');
 const path = require('path');
 const tty = require('tty');
 
 const micromatch = require('micromatch');
 
+const { runProcess } = require('./helper/run-process.js');
 const { validatePackageOverrides } = require('./helper/validate-package-overrides.js');
 
+/** @typedef {import('./helper/run-process').ProcessResult} ProcessResult */
 /** @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 */
+/** @typedef {TaskNameAndConfig & { command: string; options?: import('child_process').ExecOptions; }} TaskSetup */
 /** @typedef {{ jobTitle: string; taskSetup: TaskSetup; job: Promise<ProcessResult>; }} Job */
 
 const isTerminal = tty.isatty(1);
@@ -378,42 +378,6 @@ function generateDummyJobOutput (taskName, config, output) {
 	};
 }
 
-/**
- * Exectues a process asynchronously.
- *
- * @param {string} command - The process to execute.
- * @param {childProcess.ExecOptions | undefined} [options] - The options of the `childProcess.exec()` method.
- * @returns {Promise<ProcessResult>} An object containing the result of the process execution
- */
-async function runProcess (command, options) {
-	return new Promise((resolve) => {
-		const startTimestamp = performance.now();
-
-		/** @type {string[]} */
-		const stdout = [];
-
-		/** @type {string[]} */
-		const stderr = [];
-
-		const lintingProcess = childProcess.exec(command, options);
-
-		lintingProcess.stdout?.on('data', (/** @type {string} */data) => {
-			stdout.push(data);
-		});
-
-		lintingProcess.stderr?.on('data', (/** @type {string} */data) => {
-			stderr.push(data);
-		});
-
-		lintingProcess.on('exit', (code) => resolve({
-			code: code ?? 0,
-			stdout: stdout.join(''),
-			stderr: stderr.join(''),
-			runtime: performance.now() - startTimestamp
-		}));
-	});
-}
-
 /**
  * Returns the title (command line string) of a specific job.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "2.13.0",
+	"version": "2.14.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -32,15 +32,16 @@
 		"publish:major": "npm version major",
 		"publish:minor": "npm version minor",
 		"publish:patch": "npm version patch",
-		"lint": "node ./lint tsc ts md audit --min-severity=critical",
+		"lint": "npm run validate-stylelint-options && node ./lint tsc ts md audit --min-severity=critical",
 		"preversion": "npm run check-outdated && npm run stylelint-find-rules && npm run lint",
 		"postversion": "git push && git push --tags && npm publish",
 		"stylelint-find-rules": "stylelint-find-new-rules ./stylelint/index.js",
+		"validate-stylelint-options": "node ./validate-stylelint-options",
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.21.0",
-		"@typescript-eslint/parser": "5.21.0",
+		"@typescript-eslint/eslint-plugin": "5.22.0",
+		"@typescript-eslint/parser": "5.22.0",
 		"eslint": "8.14.0",
 		"eslint-import-resolver-typescript": "2.7.1",
 		"eslint-import-resolver-webpack": "0.13.2",
@@ -48,17 +49,17 @@
 		"eslint-plugin-functional": "4.2.1",
 		"eslint-plugin-import": "2.26.0",
 		"eslint-plugin-jest": "26.1.5",
-		"eslint-plugin-jsdoc": "39.2.8",
+		"eslint-plugin-jsdoc": "39.2.9",
 		"eslint-plugin-jsx-a11y": "6.5.1",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.0.0",
 		"eslint-plugin-react": "7.29.4",
-		"eslint-plugin-react-hooks": "4.4.0",
+		"eslint-plugin-react-hooks": "4.5.0",
 		"eslint-plugin-unicorn": "42.0.0",
 		"markdownlint-cli": "0.31.1",
 		"micromatch": "4.0.5",
 		"postcss-scss": "4.0.4",
-		"stylelint": "14.7.1",
+		"stylelint": "14.8.2",
 		"stylelint-declaration-block-no-ignored-properties": "2.5.0",
 		"stylelint-order": "5.0.0",
 		"stylelint-scss": "4.2.0",
@@ -70,10 +71,10 @@
 		"typescript": "^4.0.0"
 	},
 	"devDependencies": {
-		"@types/eslint": "8.4.1",
+		"@types/eslint": "8.4.2",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "17.0.27",
+		"@types/node": "17.0.31",
 		"stylelint-find-new-rules": "4.0.0",
-		"typescript": "4.6.3"
+		"typescript": "4.6.4"
 	}
 }

package/stylelint/index.js

@@ -157,7 +157,7 @@ module.exports = {
 				]
 			}
 		],
-		'declaration-property-max-values': [true, { 'unprefixed-property-name': 4 }],
+		'declaration-property-max-values': { '/.*/': 4 },
 		'declaration-no-important': [true, {
 			severity: 'warning'
 		}],
@@ -194,6 +194,7 @@ module.exports = {
 		'function-whitespace-after': 'always',
 		'hue-degree-notation': 'number', // @todo change that to 'angle'?
 		'indentation': 'tab',
+		'keyframe-block-no-duplicate-selectors': true,
 		'keyframe-declaration-no-important': true,
 		'keyframes-name-pattern': '^[a-z]+(-[a-z]+)*\\d*$',
 		'length-zero-no-unit': true,

package/validate-stylelint-options.js

@@ -0,0 +1,52 @@
+/**
+ * @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, '* {\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.join('\n'));
+
+		process.exitCode = 1;
+
+		return;
+	}
+
+	if (invalidOptionWarnings.length > 0) {
+		process.stderr.write(`Invalid stylelint configuration:\n\n- ${invalidOptionWarnings.map(({ text }) => text).join('\n- ')}`);
+
+		process.exitCode = 1;
+
+		return;
+	}
+})();

package/.eslintrc.js

@@ -1,12 +0,0 @@
-/**
- * @file Configuration used for linting the linter-bundle.
- */
-
-module.exports = {
-	root: true,
-	extends: [
-		require.resolve('./eslint'),
-		require.resolve('./eslint/overrides-javascript-lazy'),
-		require.resolve('./eslint/overrides-jsdoc')
-	]
-};

package/.markdownlint.json

@@ -1,3 +0,0 @@
-{
-	"extends": "markdownlint/base.json"
-}

package/tsconfig.json

@@ -1,47 +0,0 @@
-{
-	"compilerOptions": {
-		// General settings for code interpretation
-		"target": "esnext",
-		"module": "commonjs",
-		"resolveJsonModule": true,
-		"checkJs": true,
-		"noEmit": true,
-
-		"baseUrl": ".",
-
-		// General settings for code generation
-		"newLine": "LF",
-
-		// Console output settings
-		"pretty": true,
-
-		// Code validation
-		"allowUnreachableCode": false,
-		"allowUnusedLabels": false,
-		"alwaysStrict": true,
-		"exactOptionalPropertyTypes": true,
-		"forceConsistentCasingInFileNames": true,
-		"keyofStringsOnly": false,
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noImplicitThis": true,
-		"noImplicitUseStrict": false,
-		"noPropertyAccessFromIndexSignature": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"strict": true,
-		"strictBindCallApply": true,
-		"strictFunctionTypes": true,
-		"strictNullChecks": true,
-		"strictPropertyInitialization": true,
-		"suppressExcessPropertyErrors": false,
-		"suppressImplicitAnyIndexErrors": true,
-		"useUnknownInCatchVariables": true
-	},
-    "include": [
-		"./types.d.ts",
-		"**/*.js",
-		"./.eslintrc.js"
-	]
-}