linter-bundle 6.2.1 → 6.3.0

package/CHANGELOG.md

@@ -6,7 +6,38 @@ 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.2.1...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v6.3.0...HEAD)
+
+## [6.3.0] - 2024-02-06
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint/eslint-plugin` from `6.19.1` to `6.21.0`
+- [eslint] Updated `eslint-plugin-unicorn` from `50.0.1` to `51.0.0`
+- [eslint/overrides-jsdoc] Updated `eslint-plugin-jsdoc` from `48.0.3` to `48.0.5`
+- [markdownlint] Updated `markdownlint-cli` from `0.38.0` to `0.39.0`
+- [stylelint] Updated `stylelint` from `16.2.0` to `16.2.1`
+- [eslint] Make use of [`@typescript-eslint/no-array-delete`](https://typescript-eslint.io/rules/no-array-delete/) rule
+- [eslint] Make use of [`@typescript-eslint/no-useless-template-literals`](https://typescript-eslint.io/rules/no-useless-template-literals/) rule
+- [eslint] Make use of [`@typescript-eslint/prefer-find`](https://typescript-eslint.io/rules/prefer-find/) rule
+- [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
+
+### Added
+
+- [eslint] Added "Params" to the [unicorn/prevent-abbreviations](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/v32.0.1/docs/rules/prevent-abbreviations.md) `ignore` list.
+- [eslint] Added the possibility to configure additional options for the [`@typescript-eslint/naming-convention`](https://typescript-eslint.io/rules/naming-convention/) rule in the `overrides.general` linter-bundle configuration
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v6.2.2...v6.3.0)
+
+## [6.2.2] - 2024-01-25
+
+### Fixed
+
+- [eslint/overrides-jest] Changed `jest/no-confusing-set-time` to correct rule name [`jest/no-confusing-set-timeout`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-confusing-set-timeout.md)
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v6.2.1...v6.2.2)
 
 ## [6.2.1] - 2024-01-25
 
@@ -49,7 +80,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Make use of new [`no-object-constructor`](https://eslint.org/docs/latest/rules/no-object-constructor) rule
 - [eslint] Make use of new [`unicorn/no-unnecessary-polyfills`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-unnecessary-polyfills.md) rule
 - [markdownlint] Make use of new [`MD054`/link-image-style](https://github.com/DavidAnson/markdownlint/blob/main/doc/md054.md) rule
-- [eslint/overrides-jest] Make use of new [`jest/no-confusing-set-time`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-confusing-set-timeout.md) rule
+- [eslint/overrides-jest] Make use of new [`jest/no-confusing-set-timeout`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-confusing-set-timeout.md) rule
 - [eslint/overrides-jsdoc] Make use of [`jsdoc/informative-docs`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md) rule
 - [stylelint] Make use of new [`lightness-notation`](https://stylelint.io/user-guide/rules/lightness-notation/) rule with option "percentage"
 - [stylelint] Make use of new [`scss/at-root-no-redundant`](https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/at-root-no-redundant/README.md) rule
@@ -1325,7 +1356,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [eslint] Make use of new [`jsdoc/no-multi-asterisks`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-multi-asterisks) rule
 - [eslint] Added but disabled the [`jsdoc/tag-lines`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-tag-lines) rule
 - [eslint] Added but disabled the [`import/no-import-module-exports`](https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-import-module-exports.md) rule
-- [eslint/overrides-javascript(-lazy)] Added "args" the the [unicorn/prevent-abbreviations](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/v32.0.1/docs/rules/prevent-abbreviations.md) `allowList`.
+- [eslint/overrides-javascript(-lazy)] Added "args" to the [unicorn/prevent-abbreviations](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/v32.0.1/docs/rules/prevent-abbreviations.md) `ignore` list.
 
 ### Changed
 

package/README.md

@@ -189,6 +189,15 @@ The file itself, and any of the options is optional.
         },
         "import/order": {
           "additionalExternalPatterns": ["@sentry/*"]
+        },
+        "@typescript-eslint/naming-convention": {
+          "additionalOptions": [
+            {
+              "selector": "variable",
+              "modifiers": ["const"],
+              "format": ["camelCase"]
+            }
+          ]
         }
       },
       "react": {

package/eslint/index.cjs

@@ -358,7 +358,7 @@ module.exports = {
 				'prefer-named-capture-group': 'off', // ES2018+, not supported in most browsers yet
 				'prefer-numeric-literals': 'error',
 				'prefer-object-spread': 'error',
-				'prefer-promise-reject-errors': 'error',
+				'prefer-promise-reject-errors': 'off', // Covered by @typescript-eslint/prefer-promise-reject-errors
 				'prefer-regex-literals': 'error',
 				'prefer-rest-params': 'error',
 				'prefer-spread': 'error',
@@ -551,6 +551,8 @@ module.exports = {
 				'@typescript-eslint/naming-convention': [
 					'error',
 
+					...ensureType.array(linterBundleConfig.ts?.overrides?.general?.['@typescript-eslint/naming-convention']?.additionalOptions),
+
 					{ selector: 'default', format: ['camelCase'] },
 
 					// Variable
@@ -663,6 +665,7 @@ module.exports = {
 					{ selector: 'typeParameter', format: ['PascalCase'] }
 				],
 				'@typescript-eslint/no-array-constructor': 'error',
+				'@typescript-eslint/no-array-delete': 'error',
 				'@typescript-eslint/no-base-to-string': 'error',
 				'@typescript-eslint/no-confusing-non-null-assertion': 'error',
 				'@typescript-eslint/no-confusing-void-expression': ['error', { ignoreArrowShorthand: true, ignoreVoidOperator: true }],
@@ -739,11 +742,13 @@ module.exports = {
 				'@typescript-eslint/no-use-before-define': ['error', { functions: false }],
 				'@typescript-eslint/no-useless-constructor': 'error',
 				'@typescript-eslint/no-useless-empty-export': 'error',
+				'@typescript-eslint/no-useless-template-literals': 'error',
 				'@typescript-eslint/no-var-requires': 'error',
 				'@typescript-eslint/non-nullable-type-assertion-style': 'off', // Conflicts with `no-non-null-assertion`, which we prefer
 				'@typescript-eslint/object-curly-spacing': ['error', 'always'],
 				'@typescript-eslint/prefer-as-const': 'error',
 				'@typescript-eslint/prefer-enum-initializers': 'off',
+				'@typescript-eslint/prefer-find': 'error',
 				'@typescript-eslint/prefer-for-of': 'error',
 				'@typescript-eslint/prefer-function-type': 'error',
 				'@typescript-eslint/prefer-includes': 'error',
@@ -751,6 +756,7 @@ module.exports = {
 				'@typescript-eslint/prefer-namespace-keyword': 'error',
 				'@typescript-eslint/prefer-nullish-coalescing': ['error', { ignoreConditionalTests: true, ignoreMixedLogicalExpressions: true }],
 				'@typescript-eslint/prefer-optional-chain': 'error',
+				'@typescript-eslint/prefer-promise-reject-errors': '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
 				'@typescript-eslint/prefer-reduce-type-parameter': 'error',
@@ -1043,7 +1049,7 @@ module.exports = {
 				'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'] }],
+				'unicorn/prevent-abbreviations': ['error', { ignore: ['args', 'i', 'j', 'i18n', /[Rr]ef/u, /[Pp]arams/u, /[Pp]rops/u] }],
 				'unicorn/relative-url-style': 'error',
 				'unicorn/require-array-join-separator': 'error',
 				'unicorn/require-number-to-fixed-digits-argument': 'error',

package/eslint/overrides-javascript.cjs

@@ -101,7 +101,7 @@ module.exports = {
 				'unicorn/no-process-exit': 'off', // n/no-process-exit
 				'unicorn/prefer-module': 'error',
 				'unicorn/prefer-node-protocol': 'off', // @todo Requires Node.js v16. Activate in 2025
-				'unicorn/prevent-abbreviations': ['error', { ignore: ['args', 'dev', 'env', 'i', 'j', 'i18n', 'pkg', 'ref', 'Ref', 'req', 'res', 'setupDevServerMiddleware'] }],
+				'unicorn/prevent-abbreviations': ['error', { ignore: ['args', 'dev', 'env', 'i', 'j', 'i18n', 'pkg', /[Rr]ef/u, 'req', 'res', 'setupDevServerMiddleware'] }],
 				'unicorn/text-encoding-identifier-case': 'off'
 			}
 		},

package/eslint/overrides-jest.cjs

@@ -70,7 +70,7 @@ module.exports = {
 				'jest/no-commented-out-tests': 'error',
 				'jest/no-conditional-expect': 'error',
 				'jest/no-conditional-in-test': 'error',
-				'jest/no-confusing-set-time': 'error',
+				'jest/no-confusing-set-timeout': 'error',
 				'jest/no-deprecated-functions': 'error',
 				'jest/no-disabled-tests': 'error',
 				'jest/no-done-callback': 'error',

package/helper/linter-bundle-config.d.ts

@@ -2,6 +2,29 @@
  * @file Type definition of `.linter-bundle.js` configuration.
  */
 
+interface NamingConventionOption {
+	// format options
+	format: ('camelCase' | 'strictCamelCase' | 'PascalCase' | 'StrictPascalCase' | 'snake_case' | 'UPPER_CASE')[] | null;
+	custom?: {
+		regex: string;
+		match: boolean;
+	};
+	leadingUnderscore?: 'forbid' | 'require' | 'requireDouble' | 'allow' | 'allowDouble' | 'allowSingleOrDouble';
+	trailingUnderscore?: 'forbid' | 'require' | 'requireDouble' | 'allow' | 'allowDouble' | 'allowSingleOrDouble';
+	prefix?: string[];
+	suffix?: string[];
+
+	// selector options
+	selector: string | string[];
+	filter?: string | {
+		regex: string;
+		match: boolean;
+	};
+	// the allowed values for these are dependent on the selector - see below
+	modifiers?: string[];
+	types?: string[];
+}
+
 export interface LinterBundleConfig {
 	verbose?: boolean;
 	timing?: boolean;
@@ -27,6 +50,7 @@ export interface LinterBundleConfig {
 				'no-restricted-properties'?: { additionalRestrictions?: { object: string; property: string; message: string; }[]; };
 				'no-restricted-syntax'?: { additionalRestrictions?: { selector: string; message: string; }[]; };
 				'import/order'?: { additionalExternalPatterns?: string[]; };
+				'@typescript-eslint/naming-convention'?: { additionalOptions?: NamingConventionOption[]; };
 			};
 			react?: {
 				'react/forbid-component-props'?: { allowClassNameFor?: string[]; allowStyleFor?: string[]; };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "6.2.1",
+	"version": "6.3.0",
 	"type": "module",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
@@ -41,9 +41,9 @@
 		"_test-stylelint": "node ./test-stylelint.js"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "6.19.1",
-		"@typescript-eslint/parser": "6.19.1",
-		"@typescript-eslint/utils": "6.19.1",
+		"@typescript-eslint/eslint-plugin": "6.21.0",
+		"@typescript-eslint/parser": "6.21.0",
+		"@typescript-eslint/utils": "6.21.0",
 		"eslint": "8.56.0",
 		"eslint-import-resolver-typescript": "3.6.1",
 		"eslint-import-resolver-webpack": "0.13.8",
@@ -51,17 +51,17 @@
 		"eslint-plugin-functional": "6.0.0",
 		"eslint-plugin-import": "2.29.1",
 		"eslint-plugin-jest": "27.6.3",
-		"eslint-plugin-jsdoc": "48.0.3",
+		"eslint-plugin-jsdoc": "48.0.5",
 		"eslint-plugin-jsx-a11y": "6.8.0",
 		"eslint-plugin-n": "16.6.2",
 		"eslint-plugin-promise": "6.1.1",
 		"eslint-plugin-react": "7.33.2",
 		"eslint-plugin-react-hooks": "4.6.0",
-		"eslint-plugin-unicorn": "50.0.1",
-		"markdownlint-cli": "0.38.0",
+		"eslint-plugin-unicorn": "51.0.0",
+		"markdownlint-cli": "0.39.0",
 		"micromatch": "4.0.5",
 		"postcss-scss": "4.0.9",
-		"stylelint": "16.2.0",
+		"stylelint": "16.2.1",
 		"stylelint-declaration-block-no-ignored-properties": "2.8.0",
 		"stylelint-high-performance-animation": "1.10.0",
 		"stylelint-order": "6.0.4",
@@ -75,7 +75,7 @@
 	"devDependencies": {
 		"@types/eslint": "8.56.2",
 		"@types/micromatch": "4.0.6",
-		"@types/node": "20.11.6",
+		"@types/node": "20.11.16",
 		"stylelint-find-new-rules": "5.0.0",
 		"typescript": "5.3.3"
 	}