linter-bundle 3.3.0 → 3.5.0

package/CHANGELOG.md

@@ -6,7 +6,46 @@ 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.3.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.5.0...HEAD)
+
+## [3.5.0] - 2023-07-28
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint/eslint-plugin` from `6.1.0` to `6.2.0`
+- [eslint] Updated `eslint-plugin-import` from `2.27.5` to `2.28.0`
+- [eslint] Updated `eslint-plugin-jsdoc` from `46.4.4` to `46.4.5`
+- [eslint] Updated `eslint-plugin-react` from `7.32.2` to `7.33.0`
+- [eslint] Updated `eslint-plugin-unicorn` from `48.0.0` to `48.0.1`
+- [eslint] Reactivated `unicorn/no-empty-file`
+- [eslint] Activated `ignoreConditionalTests` and `ignoreMixedLogicalExpressions` options of [@typescript-eslint/prefer-nullish-coalescing](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/prefer-nullish-coalescing.md) rule
+- [styleint] Set `ignoreFunctions` option to `/^custom-/u` of [`scss/function-no-unknown`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/function-no-unknown/README.md) rule
+- [stylelint] Ignore SCSS variables in [`declaration-property-value-no-unknown`](https://stylelint.io/user-guide/rules/declaration-property-value-no-unknown/) rule
+- [stylelint] Ignore wrapping parentheses for `grid-template-areas` values in [`declaration-property-value-no-unknown`](https://stylelint.io/user-guide/rules/declaration-property-value-no-unknown/) rule
+
+### Added
+
+- Replace the ESLint rule `class-methods-use-this` by the new [`@typescript-eslint/class-methods-use-this`](https://typescript-eslint.io/rules/class-methods-use-this/) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.4.0...v3.5.0)
+
+## [3.4.0] - 2023-07-20
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `6.0.0` to `6.1.0`
+- [eslint] Updated `eslint` from `8.44.0` to `8.45.0`
+- [eslint] Updated `eslint-plugin-jsdoc` from `46.4.3` to `46.4.4`
+- [eslint] Updated `eslint-plugin-unicorn` from `47.0.0` to `48.0.0`
+- [stylelint] Updated `stylelint` from `15.10.1` to `15.10.2`
+- [eslint] Moved `unicorn/import-style` configuration for `path` (unassigned: false, default: false, namespace: true, named: true) from `overrides-storybook` into the main configuration.
+- [eslint/overrides-javascript] Activated [`unicorn/prefer-top-level-await`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-top-level-await.md) rule for `*.mjs` files.
+
+### Fixed
+
+- [stylelint] Fixed `Cannot find module 'node_modules/stylelint/bin/stylelint.js'` issue, if the file is called `stylelint.mjs`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v3.3.0...v3.4.0)
 
 ## [3.3.0] - 2023-07-13
 

package/eslint/index.js

@@ -125,7 +125,7 @@ module.exports = {
 				'brace-style': 'off', // Covered by @typescript-eslint/brace-style
 				'camelcase': 'off', // Covered by @typescript-eslint/naming-convention
 				'capitalized-comments': 'off',
-				'class-methods-use-this': ['error', { exceptMethods: ['componentDidMount', 'componentDidUpdate', 'componentWillUnmount', 'shouldComponentUpdate'] }],
+				'class-methods-use-this': 'off', // Covered by @typescript-eslint/class-methods-use-this
 				'comma-dangle': 'off', // Covered by @typescript-eslint/comma-dangle
 				'comma-spacing': 'off', // Covered by @typescript-eslint/comma-spacing
 				'comma-style': 'error',
@@ -423,9 +423,8 @@ module.exports = {
 				}],
 				'@typescript-eslint/brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
 				'@typescript-eslint/class-literal-property-style': 'error',
-				'@typescript-eslint/comma-dangle': ['error', {
-					generics: 'ignore'
-				}],
+				'@typescript-eslint/class-methods-use-this': ['error', { exceptMethods: ['componentDidMount', 'componentDidUpdate', 'componentWillUnmount', 'shouldComponentUpdate'] }],
+				'@typescript-eslint/comma-dangle': ['error', { generics: 'ignore' }],
 				'@typescript-eslint/comma-spacing': 'error',
 				'@typescript-eslint/consistent-generic-constructors': 'error',
 				'@typescript-eslint/consistent-indexed-object-style': 'error',
@@ -745,7 +744,7 @@ module.exports = {
 				'@typescript-eslint/prefer-includes': 'error',
 				'@typescript-eslint/prefer-literal-enum-member': 'error',
 				'@typescript-eslint/prefer-namespace-keyword': 'error',
-				'@typescript-eslint/prefer-nullish-coalescing': 'error',
+				'@typescript-eslint/prefer-nullish-coalescing': ['error', { ignoreConditionalTests: true, ignoreMixedLogicalExpressions: true }],
 				'@typescript-eslint/prefer-optional-chain': 'error',
 				'@typescript-eslint/prefer-readonly': 'error',
 				'@typescript-eslint/prefer-readonly-parameter-types': ['off', { ignoreInferredTypes: true }], // @todo An interface should ensure that it's properties are readonly, not every usage of it
@@ -941,7 +940,16 @@ module.exports = {
 						/([A-Za-z0-9]?[a-z0-9]+)*[A-Z]{2,4}([A-Za-z0-9]?[a-z0-9]+)*/u // Up to 4 Characters can be upper-case in a row (e.g. in `prepareDOM` or `SVGIcon`)
 					]
 				}],
-				'unicorn/import-style': 'error',
+				'unicorn/import-style': ['error', {
+					styles: {
+						path: {
+							unassigned: false,
+							default: false,
+							namespace: true,
+							named: true
+						}
+					}
+				}],
 				'unicorn/new-for-builtins': 'error',
 				'unicorn/no-abusive-eslint-disable': 'error',
 				'unicorn/no-array-callback-reference': 'off', // If I use functions, they are the best option for this use-case
@@ -952,7 +960,7 @@ module.exports = {
 				'unicorn/no-await-expression-member': 'error',
 				'unicorn/no-console-spaces': 'error',
 				'unicorn/no-document-cookie': '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-empty-file': 'error',
 				'unicorn/no-for-loop': 'off', // @typescript-eslint/prefer-for-of
 				'unicorn/no-hex-escape': 'error',
 				'unicorn/no-instanceof-array': 'error',
@@ -972,7 +980,6 @@ module.exports = {
 				'unicorn/no-unnecessary-await': 'error',
 				'unicorn/no-unreadable-array-destructuring': 'error',
 				'unicorn/no-unreadable-iife': 'error',
-				'unicorn/no-unsafe-regex': 'off',
 				'unicorn/no-unused-properties': 'error',
 				'unicorn/no-useless-fallback-in-spread': 'error',
 				'unicorn/no-useless-promise-resolve-reject': 'error',
@@ -1021,13 +1028,13 @@ module.exports = {
 				'unicorn/prefer-set-has': 'error',
 				'unicorn/prefer-set-size': 'error',
 				'unicorn/prefer-spread': 'off', // @todo Disabled till there a solution for the warning, that `slice()` on Typed-Arrays should be replaced (which is not possible). @see https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1064
-				'unicorn/prefer-string-replace-all': 'off', // @todo Available since 2020 in browsers. SHould this be preferred?
+				'unicorn/prefer-string-replace-all': 'off', // @todo Available since 2020 in browsers. Should this be preferred?
 				'unicorn/prefer-string-slice': 'off', // @todo As of today (2020.08.24) and since the last 9 years, substr() is three times faster than slice() in Firefox.
 				'unicorn/prefer-string-starts-ends-with': 'error',
 				'unicorn/prefer-string-trim-start-end': 'error',
 				'unicorn/prefer-switch': 'error',
 				'unicorn/prefer-ternary': 'off', // We prefer readability over saving a few chars
-				'unicorn/prefer-top-level-await': 'off', // @todo There should be a detection that this option is only activated on Node.js v14.8 environments and above (Check for "engine" property in package.json, and "node -v")
+				'unicorn/prefer-top-level-await': 'off', // @todo Available since 2021. Activate in 2024
 				'unicorn/prefer-regexp-test': 'error',
 				'unicorn/prefer-type-error': 'error',
 				'unicorn/prevent-abbreviations': ['error', { ignore: ['args', 'i', 'j', 'i18n', 'ref', 'Ref', 'params', 'props', 'Props'] }],

package/eslint/overrides-javascript-lazy.js

@@ -7,11 +7,10 @@ const overridesJavaScript = require('./overrides-javascript');
 module.exports = {
 	...overridesJavaScript,
 	overrides: [
+		...overridesJavaScript.overrides,
 		{
-			...overridesJavaScript.overrides[0],
+			files: ['*.js', '*.cjs', '*.mjs'],
 			rules: {
-				...overridesJavaScript.overrides[0].rules,
-
 				/**
 				 * typescript-eslint
 				 *

package/eslint/overrides-javascript.js

@@ -103,6 +103,12 @@ module.exports = {
 				'unicorn/prevent-abbreviations': ['error', { ignore: ['args', 'dev', 'env', 'i', 'j', 'i18n', 'pkg', 'ref', 'Ref', 'req', 'res', 'setupDevServerMiddleware'] }],
 				'unicorn/text-encoding-identifier-case': 'off'
 			}
+		},
+		{
+			files: ['*.mjs'],
+			rules: {
+				'unicorn/prefer-top-level-await': 'error'
+			}
 		}
 	]
 };

package/eslint/overrides-storybook.js

@@ -23,23 +23,7 @@ module.exports = {
 				 *
 				 * @see https://github.com/import-js/eslint-plugin-import
 				 */
-				'import/no-nodejs-modules': 'off',
-
-				/**
-				 * eslint-plugin-unicorn
-				 *
-				 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
-				 */
-				'unicorn/import-style': ['error', {
-					styles: {
-						path: {
-							unassigned: false,
-							default: false,
-							namespace: true,
-							named: true
-						}
-					}
-				}]
+				'import/no-nodejs-modules': 'off'
 			}
 		},
 		{

package/helper/ensure-type.js

@@ -5,6 +5,7 @@
 /**
  * Ensures that the input `value` is an array, otherwise an empty array is returned.
  *
+ * @public
  * @template T
  * @param {T} value - The value which should be checked.
  * @returns {T extends Array<any> ? T : []} Either the input array, or an empty array, if the input array is not an array.

package/helper/find-missing-overrides.js

@@ -13,6 +13,7 @@ const path = require('path');
 /**
  * Detects if installed versions of dependencies don't match to the required dependencies.
  *
+ * @public
  * @returns {Dependency[]} An array of missing overrides (=wrong versions).
  */
 function findMissingOverrides () {

package/helper/get-stylelint-path.js

@@ -0,0 +1,32 @@
+/**
+ * @file Returns the path to the Stylelint CLI script.
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Returns if the project is using npm or yarn.
+ *
+ * @public
+ * @returns {string | null} Return the path to the Stylelint CLI script, or `null` if it can't be found.
+ */
+function getStylelintPath () {
+	const stylelintLibPath = path.dirname(require.resolve('stylelint'));
+
+	for (const stylelintBinPath of [
+		path.join(stylelintLibPath, '../bin/stylelint.mjs'),
+		path.join(stylelintLibPath, '../bin/stylelint.js')
+	]) {
+		if (fs.existsSync(stylelintBinPath)) {
+			return stylelintBinPath;
+		}
+	}
+
+	return null;
+}
+
+module.exports = {
+	getStylelintPath
+};
+

package/helper/is-npm-or-yarn.js

@@ -8,6 +8,7 @@ const path = require('path');
 /**
  * Returns if the project is using npm or yarn.
  *
+ * @public
  * @returns {'none' | 'npm' | 'yarn' | 'both'} Returns which package manager name.
  */
 function isNpmOrYarn () {

package/helper/run-process.js

@@ -9,6 +9,7 @@ const childProcess = require('child_process');
 /**
  * Executes a process asynchronously.
  *
+ * @public
  * @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

package/helper/validate-package-overrides.js

@@ -13,6 +13,7 @@ const path = require('path');
 /**
  * Detects outdated "overrides"/"resolutions" dependencies.
  *
+ * @public
  * @returns {{ overrides: Dependency[]; resolutions: Dependency[]; }} Either the input array, or an empty array, if the input array is not an array.
  */
 function validatePackageOverrides () {

package/lint.js

@@ -10,6 +10,7 @@ const tty = require('tty');
 const micromatch = require('micromatch');
 
 const { findMissingOverrides } = require('./helper/find-missing-overrides.js');
+const { getStylelintPath } = require('./helper/get-stylelint-path.js');
 const { isNpmOrYarn } = require('./helper/is-npm-or-yarn.js');
 const { runProcess } = require('./helper/run-process.js');
 const { validatePackageOverrides } = require('./helper/validate-package-overrides.js');
@@ -115,10 +116,18 @@ void (async () => {
 					});
 				}
 
+				const stylelintBinPath = getStylelintPath();
+
+				if (stylelintBinPath === null) {
+					return generateDummyJobOutput(taskName, config, {
+						stderr: 'Stylelint CLI script not found.'
+					});
+				}
+
 				return runTask({
 					taskName,
 					config,
-					command: `node "${path.join(path.dirname(require.resolve('stylelint')), '../bin/stylelint.js')}" ${includes} --formatter unix`
+					command: `node "${stylelintBinPath}" ${includes} --formatter unix`
 				});
 			}
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "3.3.0",
+	"version": "3.5.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -36,31 +36,31 @@
 		"preversion": "npm run check-outdated && 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",
+		"validate-stylelint-options": "node ./validate-stylelint-options.mjs",
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "6.0.0",
-		"@typescript-eslint/parser": "6.0.0",
-		"@typescript-eslint/utils": "6.0.0",
-		"eslint": "8.44.0",
+		"@typescript-eslint/eslint-plugin": "6.2.0",
+		"@typescript-eslint/parser": "6.2.0",
+		"@typescript-eslint/utils": "6.2.0",
+		"eslint": "8.45.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-import": "2.28.0",
 		"eslint-plugin-jest": "27.2.3",
-		"eslint-plugin-jsdoc": "46.4.3",
+		"eslint-plugin-jsdoc": "46.4.5",
 		"eslint-plugin-jsx-a11y": "6.7.1",
 		"eslint-plugin-n": "16.0.1",
 		"eslint-plugin-promise": "6.1.1",
-		"eslint-plugin-react": "7.32.2",
+		"eslint-plugin-react": "7.33.0",
 		"eslint-plugin-react-hooks": "4.6.0",
-		"eslint-plugin-unicorn": "47.0.0",
+		"eslint-plugin-unicorn": "48.0.1",
 		"markdownlint-cli": "0.35.0",
 		"micromatch": "4.0.5",
 		"postcss-scss": "4.0.6",
-		"stylelint": "15.10.1",
+		"stylelint": "15.10.2",
 		"stylelint-declaration-block-no-ignored-properties": "2.7.0",
 		"stylelint-order": "6.0.3",
 		"stylelint-scss": "5.0.1",
@@ -71,9 +71,9 @@
 		"typescript": "^4.0.0"
 	},
 	"devDependencies": {
-		"@types/eslint": "8.44.0",
+		"@types/eslint": "8.44.1",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "20.4.2",
+		"@types/node": "20.4.5",
 		"stylelint-find-new-rules": "4.1.0",
 		"typescript": "5.1.6"
 	}

package/stylelint/index.js

@@ -155,7 +155,9 @@ module.exports = {
 			true,
 			{
 				ignoreProperties: {
-					'initial-value': '/.+/'
+					'initial-value': /.+/u,
+					'grid-template-areas': /^\([^\u0000]+\)$/u, // Whole block wrapped in parentheses.
+					'/.+/': /((^|\s)\$[a-z])|/ui // SCSS variables
 				}
 			}
 		],
@@ -901,7 +903,8 @@ module.exports = {
 		'scss/dollar-variable-empty-line-after': [
 			'always',
 			{
-				except: ['last-nested', 'before-dollar-variable']
+				except: ['last-nested', 'before-dollar-variable'],
+				ignore: ['before-comment', 'inside-single-line-block']
 			}
 		],
 		'scss/dollar-variable-first-in-block': [true, { ignore: ['comments', 'imports'] }],
@@ -918,7 +921,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-no-unknown': [true, { ignoreFunctions: [/^custom-/u] }],
 		'scss/function-quote-no-quoted-strings-inside': true,
 		'scss/function-unquote-no-unquoted-strings-inside': true,
 		'scss/map-keys-quotes': 'always',