linter-bundle 6.3.0 → 7.1.0

package/.linter-bundle.js

@@ -1,11 +1,10 @@
+/**
+ * @file Configuration used for linting the linter-bundle.
+ */
+
 const snippets = {
-	lowerCase: '[a-z]*([a-z0-9])',
-	upperCase: '[A-Z]*([A-Z0-9])',
-	snakeCase: '[a-z]*(*([a-z0-9]_)+([a-z0-9]))',
-	screamingSnakeCase: '[A-Z]*(*([A-Z0-9]_)+([A-Z0-9]))',
 	kebabCase: '[a-z]*(*([a-z0-9]-)+([a-z0-9]))',
-	camelCase: '[a-z]*([a-zA-Z0-9])',
-	pascalCase: '[A-Z]*([a-zA-Z0-9])'
+	camelCase: '[a-z]*([a-zA-Z0-9])'
 };
 
 export default {
@@ -19,18 +18,18 @@ export default {
 					'.git/**',
 					'.github/FUNDING.yml',
 					'.vscode/settings.json',
-					`eslint/rules/package.json`,
-					`eslint/rules/${snippets.kebabCase}.{js,md}`,
-					`eslint/{index.cjs,overrides-${snippets.kebabCase}.cjs}`,
+					`eslint/rules/${snippets.kebabCase}.{js,mjs,md}`,
+					`eslint/rules/helper/${snippets.kebabCase}.{js,mjs,md}`,
+					`eslint/${snippets.kebabCase}.mjs`,
 					'files/index.js',
-					`helper/${snippets.kebabCase}.{js,cjs,d.ts}`,
+					`helper/${snippets.kebabCase}.{js,mjs,cjs,d.ts}`,
 					'markdownlint/base.json',
 					'node_modules/**',
-					'stylelint/index.cjs',
+					'stylelint/index.mjs',
 					`stylelint/plugins/stylelint-${snippets.kebabCase}.js`,
-					`stylelint/plugins/stylelint-15.11.0-stylistic/**/{${snippets.camelCase}.cjs,README.md,LICENSE}`,
+					`stylelint/plugins/stylelint-15.11.0-stylistic/**/{${snippets.camelCase}.mjs,README.md,LICENSE}`,
 					'.editorconfig',
-					'.eslintrc.cjs',
+					'eslint.config.mjs',
 					'.gitattributes',
 					'.gitignore',
 					'.linter-bundle.js',
@@ -38,13 +37,13 @@ export default {
 					'.markdownlint.json',
 					'.npmignore',
 					'*.md',
-					'eslint.cjs',
+					'eslint.mjs',
 					'LICENSE',
 					'lint.js',
 					'package-lock.json',
 					'package.json',
-					'stylelint.cjs',
-					'stylelint.config.cjs',
+					'stylelint.mjs',
+					'stylelint.config.js',
 					'test-stylelint.js',
 					'tsconfig.json',
 					'vscode-eslint-1.png',
@@ -52,5 +51,16 @@ export default {
 				]
 			}
 		]
+	},
+	ts: {
+		overrides: {
+			general: {
+				'import/order': {
+					additionalExternalPatterns: [
+						'@stylistic/**'
+					]
+				}
+			}
+		}
 	}
-}
+};

package/.linter-bundle.schema.json

@@ -14,6 +14,15 @@
 		"files": {
 			"type": "object",
 			"properties": {
+				"git": {
+					"type": "boolean"
+				},
+				"include": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
 				"restrictions": {
 					"type": "array",
 					"items": {
@@ -59,6 +68,12 @@
 		"ts": {
 			"type": "object",
 			"properties": {
+				"timing": {
+					"type": "boolean"
+				},
+				"git": {
+					"type": "boolean"
+				},
 				"tsconfig": {
 					"type": "string"
 				},
@@ -92,12 +107,42 @@
 		"sass": {
 			"type": "object",
 			"properties": {
+				"verbose": {
+					"type": "boolean"
+				},
+				"timing": {
+					"type": "boolean"
+				},
+				"git": {
+					"type": "boolean"
+				},
+				"include": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
 				"patternPrefix": {
 					"type": "string"
 				}
 			},
 			"additionalProperties": false
 		},
+		"md": {
+			"type": "object",
+			"properties": {
+				"git": {
+					"type": "boolean"
+				},
+				"include": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			},
+			"additionalProperties": false
+		},
 		"audit": {
 			"type": "object",
 			"properties": {

package/CHANGELOG.md

@@ -6,7 +6,149 @@ 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/v6.3.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v7.1.0...HEAD)
+
+## [7.1.0] - 2025-03-15
+
+### Fixed
+
+- [eslint/jest] Fix code for Jest Version detection
+
+### Changed
+
+- [general] Suppress Node.js warnings, such as 'ExperimentalWarning: Importing JSON modules is an experimental feature and might change at any time' (which is triggered by ESLint)
+- [eslint] Added custom linter rule [`linter-bundle/enforce-logical-expression-parens`](./eslint/rules/enforce-logical-expression-parens.md) which enforces parentheses around logical operations
+- [eslint] Added custom linter rule [`linter-bundle/enforce-ternary-parens`](./eslint/rules/enforce-ternary-parens.md) which ensures ternary expressions are wrapped in parentheses
+- [eslint] Added custom linter rule [`linter-bundle/no-extra-spaces-in-generics`](./eslint/rules/no-extra-spaces-in-generics.md) to disallows spaces after the `<` and before the `>` in TypeScript generics
+- [eslint] Added custom linter rule [`linter-bundle/no-ternary-return`](./eslint/rules/no-ternary-return.md) which disallows ternary expressions as return values for better readability
+- [eslint] Configure [`padding-line-between-statements`](https://eslint.org/docs/latest/rules/padding-line-between-statements) to enforce line-breaks before `return`, `throw`, `break`, `continue`, around multi-line block statements and around `const`, `let`, `var` groups
+- [eslint/react] Added custom linter rule [`linter-bundle/ensure-lucide-import-consistency`](./eslint/rules/ensure-lucide-import-consistency.md) to enforces using [Lucide](https://lucide.dev/guide/packages/lucide-react) prefix for lucide-react imports and their usage
+- [eslint] Updated `eslint-import-resolver-typescript` from `3.8.4` to `3.9.0`
+- [stylelint] Updated `stylelint` from `16.15.0` to `16.16.0`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v7.0.0...v7.1.0)
+
+## [7.0.0] - 2025-03-11
+
+### Breaking Changes
+
+- [general] All configuration files have been migrated from CommonJS to ESModules
+- [general] The global configuration variable `global.linterBundleSettings` has been replaced by a `.linter-bundle.json` / `.linter-bundle.mjs` / `.linter-bundle.cjs` / `.linter-bundle.js` configuration file in the projects root directory
+- [eslint] It's now using the ESLint Flat Config format
+- [eslint] `.eslintrc.js` needs to be renamed to `eslint.config.mjs`, `module.exports =` needs to be replaced by `export default [`. See [eslint.org](https://eslint.org/docs/latest/use/configure/migration-guide#key-differences-between-configuration-formats) website additional required changes
+- [eslint] The VSCode configuration needs to be adapted. See [README.md](./README.md)
+- [eslint] The prefixes "override-" has been removed from the specialized rule files and the suffix `.cjs` has been replaced by `.mjs`
+- [stylelint] The stylelint configuration has been renamed from `linter-bundle/stylelint.cjs` to  `linter-bundle/stylelint.mjs`
+- [stylelint] As the interface for rules changed slightly, I had to remove some auto-fixes for the previously forked stylistic rules.
+- [general] Drop support for Node.js version less than v20.9.0 and v21.1.0 as a lot of ESLint plugins are not supporting them
+
+### Fixed
+
+- [eslint] Fixed "Error reading .linter-bundle.js" in VSCode in some conditions
+
+Beside these changes:
+
+### Changed
+
+- [general] `"extends"` in the .eslintrc.js needs to be suffixed with the ".mjs" file extension (e.g. `require.resolve('linter-bundle/eslint.mjs')`)
+- [general] `"extends"` in the stylelint.config.js needs to be suffixed with the ".mjs" file extension (e.g. `require.resolve('linter-bundle/stylelint.mjs')`)
+- [eslint] Updated `@typescript-eslint` from `6.21.0` to `8.26.1`
+- [eslint] Updated `eslint` from `8.56.0` to `9.22.0`
+- [eslint] Updated `eslint-import-resolver-typescript` from `3.6.1` to `3.8.4`
+- [eslint] Updated `eslint-import-resolver-webpack` from `0.13.8` to `0.13.10`
+- [eslint] Updated `eslint-plugin-functional` from `6.0.0` to `9.0.1`
+- [eslint] Updated `eslint-plugin-jest` from `27.6.3` to `28.11.0`
+- [eslint] Updated `eslint-plugin-jsdoc` from `48.0.5` to `50.6.6`
+- [eslint] Updated `eslint-plugin-jsx-a11y` from `6.8.0` to `6.10.2`
+- [eslint] Updated `eslint-plugin-n` from `16.6.2` to `17.16.2`
+- [eslint] Updated `eslint-plugin-promise` from `6.1.1` to `7.2.1`
+- [eslint] Updated `eslint-plugin-react` from `7.33.2` to `7.37.4`
+- [eslint] Updated `eslint-plugin-react-hooks` from `4.6.0` to `5.2.0`
+- [eslint] Updated `eslint-plugin-unicorn` from `51.0.0` to `57.0.0`
+- [eslint] Updated `@stylistic/eslint-plugin` from `2.11.0` to `4.2.0`
+- [markdownlint] Updated `markdownlint-cli` from `0.39.0` to `0.44.0`
+- [stylelint] Updated `stylelint` from `16.2.1` to `16.15.0`
+- [stylelint] Updated `stylelint-scss` from `6.1.0` to `6.11.1`
+- [stylelint] Updated `stylelint-high-performance-animation` from `1.10.0` to `1.11.0`
+- [audit] Updated `better-npm-audit` from `3.7.3` to `3.11.0`
+- [eslint] Activate `checkTypePredicates` of [`@typescript-eslint/no-unnecessary-condition`](https://typescript-eslint.io/rules/no-unnecessary-condition/) rule
+- [eslint] Adjusted `@typescript-eslint/naming-convention` rule configuration to allow constant names starting with "_" if they are unused
+- [eslint] Renamed the rule `no-unnecessary-typeof` to `linter-bundle/no-unnecessary-typeof`
+- [eslint] Renamed the rule `restricted-filenames` to `linter-bundle/restricted-filenames`
+- [eslint] Increase `max` of `import/max-dependencies` rule from 20 to 25
+- [eslint] Disabled `unicorn/string-content` as it sometimes breaks code (e.g. imports with `...` in Next.js or GraphQL template strings)
+
+### Added
+
+- [eslint] Added "_" and "c" to allowed id names in [`id-length`] rule
+- [eslint] Added [`@typescript-eslint/no-unnecessary-template-expression`](https://typescript-eslint.io/rules/no-unnecessary-template-expression/) rule (replaces `@typescript-eslint/no-useless-template-literals`)
+- [eslint] Added but disabled new [`functional/no-class-inheritance`](https://github.com/eslint-functional/eslint-plugin-functional/blob/main/docs/rules/no-class-inheritance.md) rule
+- [eslint] Added new [`@typescript-eslint/consistent-return`](https://typescript-eslint.io/rules/consistent-return/) rule
+- [eslint] Added new [`@typescript-eslint/no-unnecessary-parameter-property-assignment`](https://typescript-eslint.io/rules/no-unnecessary-parameter-property-assignment/) rule
+- [eslint] Added new [`@typescript-eslint/no-unnecessary-type-parameters`](https://typescript-eslint.io/rules/no-unnecessary-type-parameters/) rule
+- [eslint] Added new [`@typescript-eslint/no-unsafe-type-assertion`](https://typescript-eslint.io/rules/no-unsafe-type-assertion/) rule
+- [eslint] Added new [`@typescript-eslint/no-useless-assignment`](https://eslint.org/docs/latest/rules/no-useless-assignment) rule
+- [eslint] Added new [`@typescript-eslint/only-throw-error`](https://typescript-eslint.io/rules/only-throw-error/) rule
+- [eslint] Added new [`@typescript-eslint/use-unknown-in-catch-callback-variable`](https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable/) rule
+- [eslint] Added new [`no-empty-object-type`](https://typescript-eslint.io/rules/no-empty-object-type/) rule
+- [eslint] Added new [`promise/spec-only`](https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/spec-only.md) rule
+- [eslint] Added new [`unicorn/consistent-empty-array-spread`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/consistent-empty-array-spread.md) rule
+- [eslint] Added new [`unicorn/consistent-existence-index-check`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/consistent-existence-index-check.md) rule
+- [eslint] Added new [`unicorn/no-invalid-fetch-options`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-invalid-fetch-options.md) rule
+- [eslint] Added new [`unicorn/no-length-as-slice-end`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-length-as-slice-end.md) rule
+- [eslint] Added new [`unicorn/no-magic-array-flat-depth`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-magic-array-flat-depth.md) rule
+- [eslint] Added new [`unicorn/no-negation-in-equality-check`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-negation-in-equality-check.md) rule
+- [eslint] Added new [`unicorn/prefer-global-this`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-global-this.md) rule
+- [eslint] Added new [`unicorn/prefer-math-min-max`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-math-min-max.md) rule
+- [eslint] Added new [`unicorn/prefer-string-raw`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-string-raw.md) rule
+- [eslint] Added new [`unicorn/prefer-structured-clone`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-structured-clone.md) rule
+- [eslint] Added new [`unicorn/consistent-date-clone`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/consistent-date-clone.md) rule
+- [eslint] Added new [`unicorn/consistent-assert`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/consistent-assert.md) rule
+- [eslint] Added new [`unicorn/no-accessor-recursion`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-accessor-recursion.md) rule
+- [eslint] Added new [`unicorn/no-instanceof-builtins`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-instanceof-builtins.md) rule
+- [eslint] Added new [`unicorn/no-named-default`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-named-default.md) rule
+- [eslint] Replaced deprecated `unicorn/no-instanceof-array` by new [`unicorn/no-instanceof-builtins`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-instanceof-builtins.md) rule
+- [eslint] Activate `linterOptions.reportUnusedInlineConfigs` setting
+- [eslint/jsdoc] Added [`jsdoc/require-template`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md) rule
+- [eslint/jsdoc] Added but disabled new [jsdoc/convert-to-jsdoc-comments`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md) rule
+- [eslint/jsdoc] Added new [`jsdoc/check-template-names`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-template-names.md) rule
+- [eslint/jsdoc] Added new [`jsdoc/lines-before-block`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/lines-before-block.md) rule with disabled `ignoreSameLine`
+- [eslint/react] Added new [`react/forward-ref-uses-ref`](https://github.com/jsx-eslint/eslint-plugin-react/blob/v7.36.0/docs/rules/forward-ref-uses-ref.md) rule
+- [eslint/react] Activate `ignoreTranspilerName` for  [`react/display-name`](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/display-name.md)
+- [eslint/react] Activate `unicorn/prefer-node-protocol` rule
+- [eslint/react] Added new [`react/checked-requires-onchange-or-readonly`](https://github.com/jsx-eslint/eslint-plugin-react/blob/v7.34.0/docs/rules/checked-requires-onchange-or-readonly.md) rule
+- [eslint/react] Added new [`react/jsx-props-no-spread-multi`](https://github.com/jsx-eslint/eslint-plugin-react/blob/v7.35.0/docs/rules/jsx-props-no-spread-multi.md) rule
+- [eslint/jest] Added but disabled new[`jest/prefer-importing-jest-globals`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-importing-jest-globals.md) rule
+- [eslint/jest] Added new [`jest/prefer-jest-mocked`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-jest-mocked.md) rule
+- [eslint/promise] Added new [`promise/prefer-catch`](https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/prefer-catch.md) rule
+- [markdownlint] Added new [`MD058/blanks-around-tables`](https://github.com/DavidAnson/markdownlint/blob/main/doc/md058.md) rule
+- [stylelint] Added and disabled new [`scss/at-import-partial-extension-allowed-list`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-partial-extension-allowed-list/README.md) rule, and removed deprecated `at-import-partial-extension-whitelist` rule
+- [stylelint] Added and disabled new [`scss/at-import-partial-extension-disallowed-list`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-import-partial-extension-disallowed-list/README.md) rule, and removed deprecated `at-import-partial-extension-blacklist rule` rule
+- [stylelint] Added new [`no-unknown-custom-media`](https://stylelint.io/user-guide/rules/no-unknown-custom-media/) rule
+- [stylelint] Added new [`scss/at-mixin-no-risky-nesting-selector`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-mixin-no-risky-nesting-selector/README.md) rule
+- [stylelint] Added new [`scss/declaration-property-value-no-unknown`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/declaration-property-value-no-unknown/README.md) rule, which disabled `declaration-property-value-no-unknown`
+- [stylelint] Added new [`scss/function-color-channel`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/function-color-channel/README.md) rule
+- [stylelint] Added new [`scss/load-partial-extension`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/load-partial-extension/README.md) rule, and removed deprecated `at-import-partial-extension` rule
+- [stylelint] Added new [`scss/no-duplicate-load-rules`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/no-duplicate-load-rules) rule
+- [stylelint] Added new [`at-rule-descriptor-no-unknown`](https://stylelint.io/user-guide/rules/at-rule-descriptor-no-unknown/) rule
+- [stylelint] Added new [`at-rule-descriptor-value-no-unknown`](https://stylelint.io/user-guide/rules/at-rule-descriptor-value-no-unknown/) rule
+- [stylelint] Added new [`at-rule-no-deprecated`](https://stylelint.io/user-guide/rules/at-rule-no-deprecated/) rule
+- [stylelint] Added new [`at-rule-prelude-no-invalid`](https://stylelint.io/user-guide/rules/at-rule-prelude-no-invalid/) rule
+- [stylelint] Added new [`declaration-property-value-keyword-no-deprecated`](https://stylelint.io/user-guide/rules/declaration-property-value-keyword-no-deprecated/) rule
+- [stylelint] Added new [`syntax-string-no-invalid`](https://stylelint.io/user-guide/rules/syntax-string-no-invalid/) rule
+- [stylelint] Show rule performance information
+- [stylelint] Activated [`reportUnscopedDisables`] setting
+
+### Removed
+
+- [eslint] Removed deprecated `@typescript-eslint/ban-types` rule
+- [eslint] Removed deprecated `@typescript-eslint/no-throw-literal` rule
+- [eslint] Removed deprecated `no-new-symbol` rule
+- [eslint] Removed deprecated `prefer-ts-expect-error` rule
+- [eslint] Replaced deprecated `@typescript-eslint/no-loss-of-precision` rule by ESLint `no-loss-of-precision`
+- [eslint/gatsby] Removed `no-global-undefined-check` rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v6.3.0...v7.0.0)
 
 ## [6.3.0] - 2024-02-06
 
@@ -23,6 +165,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Make use of [`@typescript-eslint/prefer-promise-reject-errors`](https://typescript-eslint.io/rules/prefer-promise-reject-errors/) rule
 - [markdownlint] Make use of new [`MD054`/link-image-style](https://github.com/DavidAnson/markdownlint/blob/main/doc/md054.md) rule
 - [markdownlint] Make use of new [`MD056`/table-column-count](https://github.com/DavidAnson/markdownlint/blob/main/doc/md056.md) rule
+- [audit] Updated `improved-yarn-audit` from `3.0.0` to `3.0.3`
 
 ### Added
 
@@ -716,7 +859,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 
 - [eslint] Make use of [`@typescript-eslint/no-restricted-imports`](https://typescript-eslint.io/rules/no-restricted-imports/) rule
-- [eslint] Make use of [`@typescript-eslint/space-infix-ops`](https://typescript-eslint.io/rules/space-infix-ops/) rule
+- [eslint] Make use of [`@stylistic/space-infix-ops`](https://typescript-eslint.io/rules/space-infix-ops/) rule
 - [eslint] Make use of [`@typescript-eslint/consistent-generic-constructors`](https://typescript-eslint.io/rules/consistent-generic-constructors/) rule
 - [eslint/overrides-jest] Make use of [`jest/prefer-hooks-in-order`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-hooks-in-order.md) rule
 - [eslint/overrides-jest] Make use of [`jest/max-expects`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-expects.md) rule
@@ -1497,7 +1640,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Updated `eslint-plugin-jest` from v24.3.2 to v24.3.5
 - [eslint] Updated `eslint-plugin-react` from v7.22.0 to v7.23.2
 - [eslint] Make use of new [`react/no-unstable-nested-components`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unstable-nested-components.md) rule
-- [sass] Updated `stylelint-selector-no-empty` from v1.0.7 to v1.0.8
+- [stylelint] Updated `stylelint-selector-no-empty` from v1.0.7 to v1.0.8
 - [audit] Updated `better-npm-audit` from v1.0.7 to v1.0.8
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v1.9.0...v1.10.0)

package/README.md

@@ -22,6 +22,9 @@ This setup is using the following additional plugins:
 
 ### ESLint
 
+The `linter-bundle` is using the Flat Configuration Format which was introduced in ESLint v8.
+
+- [@stylistic/eslint-plugin](https://eslint.style/)
 - [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
 - [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)
 - [eslint-plugin-functional](https://www.npmjs.com/package/eslint-plugin-functional)
@@ -37,9 +40,13 @@ This setup is using the following additional plugins:
 
 Beside that, the following additional rules are part of this bundle:
 
-- [no-global-undefined-check](./eslint/rules/no-global-undefined-check.md)
-- [no-unnecessary-typeof](./eslint/rules/no-unnecessary-typeof.md)
-- [restricted-filenames](./eslint/rules/restricted-filenames.md)
+- [`linter-bundle/enforce-logical-expression-parens`](./eslint/rules/enforce-logical-expression-parens.md)
+- [`linter-bundle/enforce-ternary-parens`](./eslint/rules/enforce-ternary-parens.md)
+- [`linter-bundle/ensure-lucide-import-consistency`](./eslint/rules/ensure-lucide-import-consistency.md)
+- [`linter-bundle/no-extra-spaces-in-generics`](./eslint/rules/no-extra-spaces-in-generics.md)
+- [`linter-bundle/no-ternary-return`](./eslint/rules/no-ternary-return.md)
+- [`linter-bundle/no-unnecessary-typeof`](./eslint/rules/no-unnecessary-typeof.md)
+- [`linter-bundle/restricted-filenames`](./eslint/rules/restricted-filenames.md)
 
 ### stylelint
 
@@ -64,7 +71,7 @@ If these plugins are maintained again, the plugins will also be used again.
 
 ## Install
 
-Ensure you are using atleast Node.js version 18.2.0.
+Ensure you are using atleast Node.js version 20.9.0/21.1.0.
 
 ```sh
 npm install linter-bundle --save-dev
@@ -83,45 +90,43 @@ npm install linter-bundle --save-dev
 }
 ```
 
-#### .eslintrc.js
+#### eslint.config.mjs
 
 ```js
-module.exports = {
-  extends: [
-    require.resolve('linter-bundle/eslint.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-gatsby.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-javascript.cjs'),
-    require.resolve('linter-bundle/eslint/overrides-javascript-lazy.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-jest.cjs'),
-    require.resolve('linter-bundle/eslint/overrides-jsdoc.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-react.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-storybook.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-type-declarations.cjs'),
-    // require.resolve('linter-bundle/eslint/overrides-worker.cjs')
-  ]
-};
+export default [
+  ...(await import('linter-bundle/eslint.mjs')).default,
+  // ...(await import('linter-bundle/eslint/gatsby.mjs')).default,
+  // ...(await import('linter-bundle/eslint/javascript.mjs')).default,
+  ...(await import('linter-bundle/eslint/javascript-lazy.mjs')).default,
+  // ...(await import('linter-bundle/eslint/jest.mjs')).default,
+  ...(await import('linter-bundle/eslint/jsdoc.mjs')).default,
+  // ...(await import('linter-bundle/eslint/react.mjs')).default,
+  // ...(await import('linter-bundle/eslint/storybook.mjs')).default,
+  // ...(await import('linter-bundle/eslint/type-declarations.mjs')).default,
+  // ...(await import('linter-bundle/eslint/worker.mjs')).default
+]
 ```
 
 ##### Available `extends`
 
 Source | Description | Rules setup
 -|-|-
-`linter-bundle/eslint.cjs` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.cjs)
-`linter-bundle/eslint/overrides-gatsby.cjs` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
-`linter-bundle/eslint/overrides-javascript.cjs` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.cjs)
-`linter-bundle/eslint/overrides-javascript-lazy.cjs` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.cjs)
-`linter-bundle/eslint/overrides-jest.cjs` | Settings for projects using Jest. | [View](./eslint/overrides-jest.cjs)
-`linter-bundle/eslint/overrides-jsdoc.cjs` | Settings for projects using JSDoc comments. | [View](./eslint/overrides-jsdoc.cjs)
-`linter-bundle/eslint/overrides-react.cjs` | Settings for projects using React comments. | [View](./eslint/overrides-react.cjs)
-`linter-bundle/eslint/overrides-storybook.cjs` | Settings for projects using Storybook comments. | [View](./eslint/overrides-storybook.cjs)
-`linter-bundle/eslint/overrides-type-declarations.cjs` | Settings for type declaration files (.d.ts). | [View](./eslint/overrides-type-declarations.cjs)
-`linter-bundle/eslint/overrides-worker.cjs` | Settings for projects using Web Workers. | [View](./eslint/overrides-worker.cjs)
+`linter-bundle/eslint.mjs` | General rule setup. This is also the base for the following specialized rule sets. | [View](./eslint/index.mjs)
+`linter-bundle/eslint/gatsby.mjs` | Settings for Gatsby-based projects. | [View](./eslint/gatsby.mjs)
+`linter-bundle/eslint/javascript.mjs` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/javascript.mjs)
+`linter-bundle/eslint/javascript-lazy.mjs` | Can be used instead of `javascript`. It's less strict and allows the `any` type. | [View](./eslint/javascript-lazy.mjs)
+`linter-bundle/eslint/jest.mjs` | Settings for projects using Jest. | [View](./eslint/jest.mjs)
+`linter-bundle/eslint/jsdoc.mjs` | Settings for projects using JSDoc comments. | [View](./eslint/jsdoc.mjs)
+`linter-bundle/eslint/react.mjs` | Settings for projects using React comments. | [View](./eslint/react.mjs)
+`linter-bundle/eslint/storybook.mjs` | Settings for projects using Storybook comments. | [View](./eslint/storybook.mjs)
+`linter-bundle/eslint/type-declarations.mjs` | Settings for type declaration files (.d.ts). | [View](./eslint/type-declarations.mjs)
+`linter-bundle/eslint/worker.mjs` | Settings for projects using Web Workers. | [View](./eslint/worker.mjs)
 
 #### stylelint.config.js
 
 ```js
-module.exports = {
-  extends: 'linter-bundle/stylelint.cjs'
+export default {
+  extends: 'linter-bundle/stylelint.mjs'
 };
 
 ```
@@ -140,7 +145,7 @@ module.exports = {
 .eslintcache
 ```
 
-### .linter-bundle.json / .linter-bundle.cjs / .linter-bundle.js
+### .linter-bundle.json / .linter-bundle.mjs / .linter-bundle.js
 
 `linter-bundle` supports a couple of additional options, which can be configured in the configuration file, in the root of your project.  
 Some of the options are also available as command line arguments (see below).  
@@ -210,7 +215,7 @@ The file itself, and any of the options is optional.
   },
   "sass": {
     "include": ["./included/*.ts"],
-    "patternPrefix": "--my-prefix"
+    "patternPrefix": "(my-prefix|another-prefix)"
   },
   "md": {
     "include": ["./included/*.md"],
@@ -242,7 +247,7 @@ The file itself, and any of the options is optional.
 <details><summary>Click here to see the example configuration with descriptions</summary>
 
 ```js
-module.exports = {
+export default {
   /**
    * Same as `--verbose` command line argument.
    * 
@@ -268,13 +273,6 @@ module.exports = {
    * Configuration, specific to the `tsc` command.
    */
   tsc: {
-    /**
-     * `verbose`, `timing` and `git` are the same as in the root node.
-     */
-    verbose: true,
-    timing: true,
-    git: true,
-
     /**
      * Same as `--tsconfig` command line argument.
      * 
@@ -288,9 +286,8 @@ module.exports = {
    */
   ts: {
     /**
-     * `verbose`, `timing` and `git` are the same as in the root node.
+     * `timing` and `git` are the same as in the root node.
      */
-    verbose: true,
     timing: true,
     git: true,
 
@@ -320,7 +317,7 @@ module.exports = {
      */
     overrides: {
       /**
-       * Rules that are applied to `linter-bundle/eslint.cjs`.
+       * Rules that are applied to `linter-bundle/eslint.mjs`.
        */
       general: {
         'no-restricted-globals': {
@@ -374,7 +371,7 @@ module.exports = {
       },
 
       /**
-       * Rules that are applied to `linter-bundle/eslint/overrides-react.cjs`.
+       * Rules that are applied to `linter-bundle/eslint/react.mjs`.
        */
       react: {
         'react/forbid-component-props': {
@@ -426,6 +423,11 @@ module.exports = {
    * Configuration, specific to the `audit` command.
    */
   md: {
+    /**
+     * `git` is the same as in the root node.
+     */
+    git: true,
+
     /**
      * Same as `--include` command line argument.
      * 
@@ -438,13 +440,6 @@ module.exports = {
    * Configuration, specific to the `audit` command.
    */
   audit: {
-    /**
-     * `verbose`, `timing` and `git` are the same as in the root node.
-     */
-    verbose: true,
-    timing: true,
-    git: true,
-
     /**
      * Same as `--min-severity` command line argument.
      * 
@@ -465,12 +460,17 @@ module.exports = {
    */
   files: {
     /**
-     * `verbose`, `timing` and `git` are the same as in the root node.
+     * `git` is the same as in the root node.
      */
-    verbose: true,
-    timing: true,
     git: true,
 
+    /**
+     * Same as `--include` command line argument.
+     * 
+     * @type {string[]}
+     */
+    include: ['./included/*.ts'],
+
     /**
      * Array of restrictions for different base paths.
      *
@@ -633,10 +633,7 @@ This can be done by adding these options to your `.vscode/settings.json`:
 {
   "eslint.nodePath": "./node_modules/linter-bundle/node_modules/eslint",
   "eslint.options": {
-    "overrideConfigFile": "./.eslintrc.js", // or "./.eslintrc.cjs" or "./eslintrc.json"
-    "resolvePluginsRelativeTo": "./node_modules/linter-bundle",
-    "rulePaths": ["./node_modules/linter-bundle/eslint/rules"],
-    "reportUnusedDisableDirectives": "error",
+    "overrideConfigFile": "./eslint.config.mjs"
   }
 }
 ```
@@ -719,7 +716,3 @@ If you get such an error message:
 the problem is most likely, that your `tsconfig.json` does not cover your JavaScript files and that you don't have a `jsconfig.json` file in your root directory. This is required by the `@typescript-eslint` to use TypeScript for linting of JavaScript files.
 
 To solve this problem, either `"include"` your JavaScript files in your `tsconfig.json` (don't forget to set the compiler option `"checkJs"` to `true`) or create a `jsconfig.json` file in your root directory (this can be a copy of your `tsconfig.json` with an `"include"` of your JavaScript files).
-
-### In VSCode, in every file, the first line shows the error `Definition for rule "no-unnecessary-typeof" was not found. eslint(no-unnecessary-typeof)`
-
-Please ensure that you've added the configuration options as described above ("VSCode setup" > "ESLint").

package/TODO.md

@@ -1,58 +0,0 @@
-# @todo
-
-- Aktuell sind die Versionen von den Audit-Tools hardcodiert in der lint.js hinterlegt:
-  'better-npm-audit@3.7.3',
-  'improved-yarn-audit@3.0.0',
-  Das sollte irgendwo hinterlegt werden, so z.B. check-outdated drauf zugreifen kann. (z.B. die optionalDependencies? Sind diese nach dem regulären Installieren noch vorhanden und lassen sich entsprechend auslesen? Werden diese von check-outdated geprüft?)
-
-- Timing funktioniert nicht - siehe HexEd.it-core
-
-- Wie erreichen wir auto-completion in der .linter-bundle.js datei?
-  .linter-bundle.json vielleicht mit Schema-Datei?
-
-<!-- markdownlint-disable -->
-
-- Bereiche in Readme aufklappbar machen:
-<details>
- summary>yarn</summary>
-
-```shell
-yarn add click-to-react-component
-```
-</details>
-
-- 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:
-
-```bash
-Error while loading rule 'import/no-unused-modules': .eslintrc.js » ./node_modules/linter-bundle/eslint/index.js:
-Configuration for rule "@typescript-eslint/no-throw-literal" is invalid:
-Value [{"allowThrowingAny":false,"allowThrowingUnknown":true}] should NOT have more than 0 items.
-```
-
-To solve such problems, npm supports [`overrides`](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides) as of version [8.3](https://github.com/npm/cli/releases/tag/v8.3.0), while yarn supports [`resolutions`](https://classic.yarnpkg.com/en/docs/selective-version-resolutions/).
-
-By using the `enforce-deps` option, linter-bundle will ensure the right versions of the dependencies are installed, and if not it automatically write these options to your package.json and then run an `npm i` or `yarn`, before starting the linting to ensure that the correct dependency versions are installed.
-
-```json
-"overrides": {
-  "@typescript-eslint/eslint-plugin": "$linter-bundle",
-  "@typescript-eslint/parser": "$linter-bundle",
-  "eslint": "$linter-bundle"
-}
-```
-
-- Option to lint only changed files in Git
-  - [lint-staged](https://github.com/okonet/lint-staged)
-  - [affected](https://www.npmjs.com/package/affected)
-  - [git-affected-files](https://www.npmjs.com/package/git-affected-files)
-  - [affected-files](https://www.npmjs.com/package/affected-files)
-  - [is-affected](https://www.npmjs.com/package/is-affected)
-
-- Find stylelint rule which checks for wrong values like:  
-  `padding-top: 3px 3px 0;`