linter-bundle 2.11.0 → 2.13.0

package/CHANGELOG.md

@@ -6,9 +6,65 @@ 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/v2.11.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.13.0...HEAD)
 
-## [2.11.0] - 2020.03.12
+## [2.13.0] - 2022.04.25
+
+### Changed
+
+- [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] Updated `@typescript-eslint` from `5.17.0` to `5.21.0`
+- [eslint] Updated `eslint` from `8.12.0` to `8.14.0`
+- [eslint] Updated `eslint-import-resolver-typescript` from `2.7.0` to `2.7.1`
+- [eslint] Updated `eslint-plugin-functional` from `4.2.0` to `4.2.1`
+- [eslint] Updated `eslint-plugin-import` from `2.25.4` to `2.26.0`
+- [eslint] Updated `eslint-plugin-jest` from `26.1.3` to `26.1.5`
+- [eslint] Updated `eslint-plugin-jsdoc` from `38.1.4` to `39.2.8`
+- [eslint] Updated `eslint-plugin-unicorn` from `41.0.1` to `42.0.0`
+- [stylelint] Updated `postcss-scss` from `4.0.3` to `4.0.4`
+- [stylelint] Updated `stylelint` from `14.6.1` to `14.7.1`
+- [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] 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"`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.12.0...v2.13.0)
+
+## [2.12.0] - 2022.03.30
+
+### Changed
+
+- [eslint] Updated `@typescript-eslint` from `5.14.0` to `5.17.0`
+- [eslint] Updated `eslint` from `8.11.0` to `8.12.0`
+- [eslint] Updated `eslint-import-resolver-typescript` from `2.5.0` to `2.7.0`
+- [eslint] Updated `eslint-plugin-jest` from `26.1.1` to `26.1.3`
+- [eslint] Updated `eslint-plugin-jsdoc` from `38.0.2` to `38.1.4`
+- [eslint] Updated `eslint-plugin-react` from `7.29.3` to `7.29.4`
+- [eslint] Updated `eslint-plugin-react-hooks` from `4.3.0` to `4.4.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`
+- [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`
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.11.1...v2.12.0)
+
+## [2.11.1] - 2022.03.13
+
+### Changed
+
+- [eslint] Disabled `@typescript-eslint/no-redundant-type-constituents`, because of false positives with `Promise<... | never>`
+- [eslint] Weaken `@typescript-eslint/naming-convention` rule to allow names with special characters for `objectLiteralProperty`.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.11.0...v2.11.1)
+
+## [2.11.0] - 2022.03.12
 
 ### Added
 
@@ -18,12 +74,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Changed
 
 - [eslint] Updated `eslint` from `8.10.0` to `8.11.0`
-- [eslint] Update `eslint-plugin-jsdoc` from `37.9.7` to `38.0.2`
+- [eslint] Updated `eslint-plugin-jsdoc` from `37.9.7` to `38.0.2`
 - [eslint] Disabled [`unicorn/prefer-json-parse-buffer`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-json-parse-buffer.md) rule, as [TypeScript states](https://github.com/microsoft/TypeScript/issues/11842) that string needs to be used as of the ES specification.
 
 [Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.10.1...v2.11.0)
 
-## [2.10.1] - 2020.03.11
+## [2.10.1] - 2022.03.11
 
 ### Fixed
 

package/README.md

@@ -168,7 +168,7 @@ module.exports = {
 Source | Description | Rules setup
 -|-|-
 `linter-bundle/eslint` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.js)
-`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby)
+`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
 `linter-bundle/eslint/overrides-javascript` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.js)
 `linter-bundle/eslint/overrides-javascript-lazy` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.js)
 `linter-bundle/eslint/overrides-jest` | Settings for projects using Jest. | [View](./eslint/overrides-jest.js)

package/eslint/index.js

@@ -426,7 +426,7 @@ module.exports = {
 		'@typescript-eslint/consistent-type-exports': 'error',
 		'@typescript-eslint/consistent-type-imports': ['error', { disallowTypeAnnotations: false }],
 		'@typescript-eslint/dot-notation': 'error',
-		'@typescript-eslint/explicit-function-return-type': 'error',
+		'@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
 		'@typescript-eslint/explicit-member-accessibility': ['error', {
 			ignoredMethodNames: [
 				'constructor',
@@ -561,10 +561,29 @@ module.exports = {
 			},
 			{
 				selector: 'objectLiteralProperty',
+				// `__html` is a property of React's `dangerouslySetInnerHTML` object
 				filter: '^__html$',
 				types: ['string'],
 				format: null
 			},
+			{
+				// Allow properties which only contain digits
+				selector: 'objectLiteralProperty',
+				filter: '^\\d+$',
+				format: null
+			},
+			{
+				// Allow empty or one-character properties
+				selector: 'objectLiteralProperty',
+				filter: '^.?$',
+				format: null
+			},
+			{
+				// Allow properties which which don't contain an underscore (to prevent usage of "UPPER_CASE") and contain atleast 4 characters
+				selector: 'objectLiteralProperty',
+				filter: '^[^_]{4,}$',
+				format: null
+			},
 			{ selector: 'typeProperty', format: ['camelCase', 'PascalCase'] },
 			{
 				selector: 'typeProperty',
@@ -641,7 +660,7 @@ module.exports = {
 		'@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': 'error',
+		'@typescript-eslint/no-redundant-type-constituents': 'off', // False positive with Promise<... | never>
 		'@typescript-eslint/no-require-imports': 'error',
 		'@typescript-eslint/no-shadow': 'error',
 		'@typescript-eslint/no-this-alias': 'error',
@@ -670,7 +689,7 @@ module.exports = {
 		'@typescript-eslint/no-unsafe-member-access': 'error',
 		'@typescript-eslint/no-unsafe-return': 'error',
 		'@typescript-eslint/no-unused-expressions': 'error',
-		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', destructuredArrayIgnorePattern: '^_' }],
 		'@typescript-eslint/no-use-before-define': ['error', { functions: false }],
 		'@typescript-eslint/no-useless-constructor': 'error',
 		'@typescript-eslint/no-var-requires': 'error',
@@ -781,7 +800,7 @@ module.exports = {
 		'import/no-named-export': 'off',
 		'import/no-namespace': 'off', // @todo Enabling this produces a JavaScript error in the rule; anyhow - could that reduce the package size, because of improved tree-shaking/dead-code-elimination?
 		'import/no-nodejs-modules': 'error',
-		// 'import/no-relative-packages': 'error', -- Removed because of roll-back of eslint-plugin-import in version 1.18.0
+		'import/no-relative-packages': 'error',
 		'import/no-relative-parent-imports': 'off', // @todo Disabled because of a bug on Windows, re-enable as soon as it's resolved: https://github.com/import-js/eslint-plugin-import/issues/1644
 		'import/no-restricted-paths': 'error',
 		'import/no-self-import': 'error',
@@ -942,6 +961,7 @@ module.exports = {
 		'unicorn/no-thenable': 'error',
 		'unicorn/no-this-assignment': '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',
@@ -949,6 +969,7 @@ module.exports = {
 		'unicorn/no-invalid-remove-event-listener': 'error',
 		'unicorn/no-useless-length-check': 'error',
 		'unicorn/no-useless-spread': 'error',
+		'unicorn/no-useless-switch-case': 'error',
 		'unicorn/no-useless-undefined': ['error', { checkArguments: false }],
 		'unicorn/no-zero-fractions': 'error',
 		'unicorn/number-literal-case': 'error',
@@ -973,7 +994,9 @@ module.exports = {
 		'unicorn/prefer-keyboard-event-key': 'error',
 		'unicorn/prefer-math-trunc': 'error',
 		'unicorn/prefer-modern-dom-apis': 'error',
+		'unicorn/prefer-modern-math-apis': 'error',
 		'unicorn/prefer-module': 'off',
+		'unicorn/prefer-native-coercion-functions': 'off',
 		'unicorn/prefer-negative-index': 'error',
 		'unicorn/prefer-number-properties': 'error',
 		'unicorn/prefer-object-has-own': 'off', // Not widely supported yet. Can be activated in 2024

package/eslint/overrides-jsdoc.js

@@ -50,7 +50,7 @@ module.exports = {
 				'jsdoc/require-example': 'off',
 				'jsdoc/require-file-overview': 'error',
 				'jsdoc/require-hyphen-before-param-description': 'error',
-				'jsdoc/require-jsdoc': 'error',
+				'jsdoc/require-jsdoc': ['error', { minLineCount: 2 }],
 				'jsdoc/require-param-description': 'error',
 				'jsdoc/require-param-name': 'error',
 				'jsdoc/require-param-type': 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "2.11.0",
+	"version": "2.13.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -39,29 +39,29 @@
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.14.0",
-		"@typescript-eslint/parser": "5.14.0",
-		"eslint": "8.11.0",
-		"eslint-import-resolver-typescript": "2.5.0",
+		"@typescript-eslint/eslint-plugin": "5.21.0",
+		"@typescript-eslint/parser": "5.21.0",
+		"eslint": "8.14.0",
+		"eslint-import-resolver-typescript": "2.7.1",
 		"eslint-import-resolver-webpack": "0.13.2",
 		"eslint-plugin-eslint-comments": "3.2.0",
-		"eslint-plugin-functional": "4.2.0",
-		"eslint-plugin-import": "2.25.4",
-		"eslint-plugin-jest": "26.1.1",
-		"eslint-plugin-jsdoc": "38.0.2",
+		"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-jsx-a11y": "6.5.1",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.0.0",
-		"eslint-plugin-react": "7.29.3",
-		"eslint-plugin-react-hooks": "4.3.0",
-		"eslint-plugin-unicorn": "41.0.0",
+		"eslint-plugin-react": "7.29.4",
+		"eslint-plugin-react-hooks": "4.4.0",
+		"eslint-plugin-unicorn": "42.0.0",
 		"markdownlint-cli": "0.31.1",
-		"micromatch": "4.0.4",
-		"postcss-scss": "4.0.3",
-		"stylelint": "14.5.3",
+		"micromatch": "4.0.5",
+		"postcss-scss": "4.0.4",
+		"stylelint": "14.7.1",
 		"stylelint-declaration-block-no-ignored-properties": "2.5.0",
 		"stylelint-order": "5.0.0",
-		"stylelint-scss": "4.1.0",
+		"stylelint-scss": "4.2.0",
 		"stylelint-selector-no-empty": "1.0.8",
 		"stylelint-use-logical-spec": "3.2.2"
 	},
@@ -72,8 +72,8 @@
 	"devDependencies": {
 		"@types/eslint": "8.4.1",
 		"@types/micromatch": "4.0.2",
-		"@types/node": "17.0.21",
-		"stylelint-find-new-rules": "3.0.4",
-		"typescript": "4.6.2"
+		"@types/node": "17.0.27",
+		"stylelint-find-new-rules": "4.0.0",
+		"typescript": "4.6.3"
 	}
 }

package/stylelint/index.js

@@ -157,6 +157,7 @@ module.exports = {
 				]
 			}
 		],
+		'declaration-property-max-values': [true, { 'unprefixed-property-name': 4 }],
 		'declaration-no-important': [true, {
 			severity: 'warning'
 		}],
@@ -183,7 +184,7 @@ module.exports = {
 		'function-linear-gradient-no-nonstandard-direction': true,
 		'function-max-empty-lines': 0,
 		'function-name-case': 'lower',
-		'function-no-unknown': null, // @todo Create issue for false positives for "color.scale". Need this be covered by the `ignoreFunctions` option?
+		'function-no-unknown': null, // Implemented by scss/function-no-unknown
 		'function-parentheses-newline-inside': 'always-multi-line',
 		'function-parentheses-space-inside': 'never-single-line',
 		'function-url-no-scheme-relative': true,
@@ -289,6 +290,7 @@ module.exports = {
 		'selector-nested-pattern': null,
 		'selector-no-qualifying-type': [true, { ignore: ['attribute', 'class'] }],
 		'selector-no-vendor-prefix': true,
+		'selector-not-notation': 'complex',
 		'selector-pseudo-class-allowed-list': null,
 		'selector-pseudo-class-case': 'lower',
 		'selector-pseudo-class-disallowed-list': null,
@@ -890,6 +892,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-quote-no-quoted-strings-inside': true,
 		'scss/function-unquote-no-unquoted-strings-inside': true,
 		'scss/map-keys-quotes': 'always',