linter-bundle 2.3.0 → 2.6.0

package/CHANGELOG.md

@@ -6,9 +6,58 @@ 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.2.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.6.0...HEAD)
 
-## [2.2.0] - 2022.01.27
+## [2.6.0] - 2022.02.14
+
+- [eslint] Updated `@typescript-eslint/eslint-plugin` from v5.11.0 to v5.12.0
+- [eslint] Updated `@typescript-eslint/parser` from v5.11.0 to v5.12.0
+- [eslint] Updated `eslint` from v8.8.0 to v8.9.0
+- [eslint] Updated `eslint-plugin-jsdoc` from v37.8.2 to v37.9.1
+- [eslint] Ignore `generics` in [@typescript-eslint/comma-dangle](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/comma-dangle.md) to allow [generic component definitions for function components](https://wanago.io/2020/03/09/functional-react-components-with-generic-props-in-typescript/#crayon-620a96e97d44a141656396)
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.5.0...v2.6.0)
+
+## [2.5.0] - 2022.02.11
+
+- [eslint] Updated `eslint-plugin-jsdoc` from v37.8.1 to v37.8.2
+- [stylelint] Updated `stylelint` from v14.4.0 to v14.5.0
+- [eslint/overrides-gatsby] Disabled `unusedExports` and enabled `missingExports` for the [`import/no-unused-modules`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md) rule, for `src/pages/*.tsx` files.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.4.0...v2.5.0)
+
+## [2.4.0] - 2022.02.09
+
+- [eslint] Updated `@typescript-eslint/eslint-plugin` from v5.10.1 to v5.11.0
+- [eslint] Updated `eslint` from v8.7.0 to v8.8.0
+- [eslint] Updated `eslint-plugin-functional` from v4.1.1 to v4.2.0
+- [eslint] Updated `eslint-plugin-jest` from v26.0.0 to v26.1.0
+- [eslint] Updated `eslint-plugin-jsdoc` from v37.7.0 to v37.8.1
+- [markdownlint] Updated `markdownlint-cli` from v0.30.0 to v0.31.1, which adds the new rules `MD049` and `MD050` for consistent emphasis/strong style, and improves the rules `MD007`/`MD010`/`MD032`/`MD033`/`MD035`/`MD037`/`MD039`
+- [stylelint] Updated `stylelint` from v14.3.0 to v14.4.0
+- [eslint] Activated `unusedExports` option of the [`import/no-unused-modules`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unused-modules.md) rule
+- [eslint] Activate [`@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/react] Add React class methods (`componentDidMount`, `render` etc.) to the allowed names in the [`@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/jest] Make use of new [`no-conditional-in-test`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-in-test.md) rule, which deprecates `no-if`
+- [eslint/jest] Make use of new [`prefer-snapshot-hint`](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/prefer-snapshot-hint.md) rule
+- [stylelint] Added but disabled new [`function-no-unknown`](https://github.com/stylelint/stylelint/blob/main/lib/rules/function-no-unknown/README.md) rule, because of false positives
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.3.1...v2.4.0)
+
+## [2.3.1] - 2022.01.28
+
+### Fixed
+
+- [eslint/overrides-javascript(-lazy)] Move `import/no-import-module-exports` rule to`overrides-javascript`
+- [eslint/overrides-gatsby] Ignore '@reach/router' in `import/no-unresolved` rule
+- [eslint] Disabled `react/require-default-props`, because of false-positive for React.forwardRef wrapped functional components
+- [eslint] Disabled `unicorn/prefer-top-level-await`, because of false-positive on environments with Node.js below v14.8
+- [eslint] Activated `allowThrowingUnknown` option of the [`@typescript-eslint/no-throw-literal`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-throw-literal.md) rule
+- [stylelint] Activate `camelCaseSvgKeywords` option of the [`value-keyword-case`](https://github.com/stylelint/stylelint/tree/main/lib/rules/value-keyword-case) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.3.0...v2.3.1)
+
+## [2.3.0] - 2022.01.27
 
 ### Changed
 
@@ -47,7 +96,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [stylelint] Added new [`scss/at-use-no-unnamespaced`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-use-no-unnamespaced) rule
 - [stylelint] Added but disabled [`rule-selector-property-disallowed-list`](https://github.com/stylelint/stylelint/tree/main/lib/rules/rule-selector-property-disallowed-list) rule
 
-[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.1.0...v2.2.0)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.1.0...v2.3.0)
 
 ## [2.1.0] - 2021.11.07
 

package/TODO.md

@@ -1,5 +1,26 @@
 # @todo
 
+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)

package/eslint/index.js

@@ -416,7 +416,9 @@ module.exports = {
 		}],
 		'@typescript-eslint/brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
 		'@typescript-eslint/class-literal-property-style': 'error',
-		'@typescript-eslint/comma-dangle': ['error', 'never'],
+		'@typescript-eslint/comma-dangle': ['error', {
+			generics: 'ignore'
+		}],
 		'@typescript-eslint/comma-spacing': 'error',
 		'@typescript-eslint/consistent-indexed-object-style': 'error',
 		'@typescript-eslint/consistent-type-assertions': 'error',
@@ -424,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': 'off', // @todo Disabled till we can specify exceptions (React-default class methods, like render())
+		'@typescript-eslint/explicit-function-return-type': 'error',
 		'@typescript-eslint/explicit-member-accessibility': ['error', {
 			ignoredMethodNames: [
 				'constructor',
@@ -644,7 +646,7 @@ module.exports = {
 		'@typescript-eslint/no-this-alias': 'error',
 		'@typescript-eslint/no-throw-literal': ['error', {
 			allowThrowingAny: false,
-			allowThrowingUnknown: false
+			allowThrowingUnknown: true
 		}],
 		'@typescript-eslint/no-type-alias': ['off', { // @todo There should be an option like 'sub-in-unions-and-intersections', which allows `type A = (string | number)[];`
 			allowAliases: 'always',
@@ -770,7 +772,7 @@ module.exports = {
 				'workbox-window/utils/WorkboxEvent'
 			]
 		}],
-		'import/no-import-module-exports': 'error',
+		'import/no-import-module-exports': 'off', // Activated only for JavaScript files
 		'import/no-mutable-exports': 'error',
 		'import/no-named-as-default-member': 'error',
 		'import/no-named-as-default': 'error',
@@ -789,7 +791,7 @@ module.exports = {
 			]
 		}],
 		'import/no-unresolved': ['error', { caseSensitiveStrict: true }],
-		'import/no-unused-modules': 'error',
+		'import/no-unused-modules': ['error', { unusedExports: true }],
 		'import/no-useless-path-segments': 'error',
 		'import/no-webpack-loader-syntax': 'off', // Indeed, you should avoid that, but if we do it, we have a reason for it
 		'import/order': ['error', {
@@ -987,7 +989,7 @@ module.exports = {
 		'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': 'error',
+		'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-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-gatsby.js

@@ -33,6 +33,13 @@ module.exports = {
 				 */
 				'@typescript-eslint/no-confusing-void-expression': 'off', // @todo Conflicts with graphql-template strings
 
+				/**
+				 * eslint-plugin-import
+				 *
+				 * @see https://github.com/import-js/eslint-plugin-import
+				 */
+				'import/no-unresolved': ['error', { caseSensitiveStrict: true, ignore: ['@reach/router'] }],
+
 				/**
 				 * eslint-plugin-unicorn
 				 *
@@ -80,6 +87,7 @@ module.exports = {
 				 * @see https://github.com/import-js/eslint-plugin-import
 				 */
 				'import/no-default-export': 'off',
+				'import/no-unused-modules': ['error', { missingExports: true }],
 
 				/**
 				 * eslint-plugin-unicorn

package/eslint/overrides-javascript.js

@@ -42,6 +42,7 @@ module.exports = {
 				 * @see https://github.com/import-js/eslint-plugin-import
 				 */
 				'import/no-commonjs': 'off',
+				'import/no-import-module-exports': 'error',
 				'import/no-internal-modules': 'off',
 				'import/no-nodejs-modules': 'off',
 

package/eslint/overrides-jest.js

@@ -66,6 +66,7 @@ module.exports = {
 				'jest/no-alias-methods': 'error',
 				'jest/no-commented-out-tests': 'error',
 				'jest/no-conditional-expect': 'error',
+				'jest/no-conditional-in-test': 'error',
 				'jest/no-deprecated-functions': 'error',
 				'jest/no-disabled-tests': 'error',
 				'jest/no-done-callback': 'error',
@@ -74,7 +75,6 @@ module.exports = {
 				'jest/no-focused-tests': 'error',
 				'jest/no-hooks': ['error', { allow: ['beforeEach', 'afterEach', 'afterAll'] }],
 				'jest/no-identical-title': 'error',
-				'jest/no-if': 'error',
 				'jest/no-interpolation-in-snapshots': 'error',
 				'jest/no-jasmine-globals': 'error',
 				'jest/no-jest-import': 'error',
@@ -90,6 +90,7 @@ module.exports = {
 				'jest/require-hook': 'error',
 				'jest/prefer-comparison-matcher': 'error',
 				'jest/prefer-equality-matcher': 'error',
+				'jest/prefer-snapshot-hint': 'error',
 				'jest/prefer-spy-on': 'error',
 				'jest/prefer-strict-equal': 'error',
 				'jest/prefer-to-be': 'error',

package/eslint/overrides-react.js

@@ -15,6 +15,19 @@ module.exports = {
 				 * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules
 				 */
 				'@typescript-eslint/member-ordering': 'off', // For React components we are using react/sort-comp
+				'@typescript-eslint/explicit-function-return-type': ['error', {
+					allowedNames: [
+						'componentDidCatch',
+						'componentDidMount',
+						'componentDidUpdate',
+						'componentWillUnmount',
+						'getDerivedStateFromError',
+						'getDerivedStateFromProps',
+						'getSnapshotBeforeUpdate',
+						'render',
+						'shouldComponentUpdate'
+					]
+				}],
 
 				/**
 				 * eslint-plugin-react-hooks
@@ -88,7 +101,7 @@ module.exports = {
 				'react/prefer-stateless-function': 'error',
 				'react/prop-types': 'off',
 				'react/react-in-jsx-scope': 'error',
-				'react/require-default-props': ['error', { forbidDefaultForRequired: true, ignoreFunctionalComponents: true }], // @see https://medium.com/@matanbobi/react-defaultprops-is-dying-whos-the-contender-443c19d9e7f1
+				'react/require-default-props': ['off', { forbidDefaultForRequired: true, ignoreFunctionalComponents: true }], // @see https://medium.com/@matanbobi/react-defaultprops-is-dying-whos-the-contender-443c19d9e7f1 @todo Also disabled becaues of false-positive with React.forwardRef(), create bug report?
 				'react/require-optimization': 'error',
 				'react/require-render-return': 'error',
 				'react/self-closing-comp': 'error',

package/eslint/overrides-type-declarations.js

@@ -21,6 +21,7 @@ module.exports = {
 				 * @see https://github.com/import-js/eslint-plugin-import
 				 */
 				'import/no-default-export': 'off',
+				'import/no-unused-modules': 'off',
 
 				/**
 				 * eslint-plugin-unicorn

package/lint.js

@@ -121,7 +121,6 @@ const jobs = getTasksToRun(process.argv.splice(2)).map(({ taskName, config }) =>
 	throw new Error(`"${taskName}" is not a valid task.`);
 });
 
-// eslint-disable-next-line unicorn/prefer-top-level-await -- The minimum required Node.js version is v14.8, but we are also support down till v14.0
 void (async () => {
 	for (const { jobTitle, taskSetup, job } of jobs) {
 		process.stdout.write(jobTitle);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "2.3.0",
+	"version": "2.6.0",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
 		"eslint",
@@ -39,25 +39,25 @@
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "5.10.1",
-		"@typescript-eslint/parser": "5.10.1",
-		"eslint": "8.7.0",
+		"@typescript-eslint/eslint-plugin": "5.12.0",
+		"@typescript-eslint/parser": "5.12.0",
+		"eslint": "8.9.0",
 		"eslint-import-resolver-typescript": "2.5.0",
 		"eslint-import-resolver-webpack": "0.13.2",
 		"eslint-plugin-eslint-comments": "3.2.0",
-		"eslint-plugin-functional": "4.1.1",
+		"eslint-plugin-functional": "4.2.0",
 		"eslint-plugin-import": "2.25.4",
-		"eslint-plugin-jest": "26.0.0",
-		"eslint-plugin-jsdoc": "37.7.0",
+		"eslint-plugin-jest": "26.1.0",
+		"eslint-plugin-jsdoc": "37.9.1",
 		"eslint-plugin-jsx-a11y": "6.5.1",
 		"eslint-plugin-node": "11.1.0",
 		"eslint-plugin-promise": "6.0.0",
 		"eslint-plugin-react": "7.28.0",
 		"eslint-plugin-react-hooks": "4.3.0",
 		"eslint-plugin-unicorn": "40.1.0",
-		"markdownlint-cli": "0.30.0",
+		"markdownlint-cli": "0.31.1",
 		"postcss-scss": "4.0.3",
-		"stylelint": "14.3.0",
+		"stylelint": "14.5.0",
 		"stylelint-declaration-block-no-ignored-properties": "2.5.0",
 		"stylelint-order": "5.0.0",
 		"stylelint-scss": "4.1.0",
@@ -70,7 +70,7 @@
 	},
 	"devDependencies": {
 		"@types/eslint": "8.4.1",
-		"@types/node": "17.0.12",
+		"@types/node": "17.0.17",
 		"stylelint-find-new-rules": "^3.0.4",
 		"typescript": "4.5.5"
 	}

package/stylelint/index.js

@@ -183,6 +183,7 @@ module.exports = {
 		'function-linear-gradient-no-nonstandard-direction': true,
 		'function-max-empty-lines': 0,
 		'function-name-case': 'lower',
+		'function-no-unknown': false, // @todo Create issue for false positives for "color.scale". Need this be covered by the `ignoreFunctions` option?
 		'function-parentheses-newline-inside': 'always-multi-line',
 		'function-parentheses-space-inside': 'never-single-line',
 		'function-url-no-scheme-relative': true,
@@ -309,7 +310,12 @@ module.exports = {
 		'unit-case': 'lower',
 		'unit-disallowed-list': null,
 		'unit-no-unknown': true,
-		'value-keyword-case': 'lower',
+		'value-keyword-case': [
+			'lower',
+			{
+				camelCaseSvgKeywords: true
+			}
+		],
 		'value-list-comma-newline-after': 'always-multi-line',
 		'value-list-comma-newline-before': 'never-multi-line',
 		'value-list-comma-space-after': 'always-single-line',