linter-bundle 2.4.0 → 2.8.0

package/CHANGELOG.md

@@ -6,7 +6,42 @@ 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.4.0...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.8.0...HEAD)
+
+## [2.8.0] - 2022.02.18
+
+- [eslint] Update `eslint-plugin-jsdoc` from v37.9.1 to v37.9.4
+- [eslint] Update `eslint-plugin-unicorn` from v40.1.0 to v41.0.0
+- [eslint] Make use of [`unicorn/text-encoding-identifier-case`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/text-encoding-identifier-case.md) rule
+- [stylelint] Fixed disabling of [`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.7.0...v2.8.0)
+
+## [2.7.0] - 2022.02.16
+
+- [eslint] Update `eslint-plugin-jest` from v26.1.0 to v26.1.1
+- [stylelint] Update `stylelint`  from v14.5.0 to v14.5.1
+- [eslint] Activate `ignoreUsedVariables` option of [`unicorn/prefer-export-from`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-export-from.md) rule
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v2.6.0...v2.7.0)
+
+## [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
 

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',
@@ -964,7 +966,7 @@ module.exports = {
 		'unicorn/prefer-dom-node-dataset': 'off', // `setAttribute` is faster than `dataset`. See https://www.measurethat.net/Benchmarks/Show/7740/0/classname-vs-setattribute-vs-classlist-vs-dataset
 		'unicorn/prefer-dom-node-remove': 'error',
 		'unicorn/prefer-dom-node-text-content': 'error',
-		'unicorn/prefer-export-from': 'error',
+		'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
 		'unicorn/prefer-includes': 'error',
 		'unicorn/prefer-json-parse-buffer': 'error',
 		'unicorn/prefer-keyboard-event-key': 'error',
@@ -1003,6 +1005,7 @@ module.exports = {
 			}
 		}],
 		'unicorn/template-indent': 'error',
+		'unicorn/text-encoding-identifier-case': 'error',
 		'unicorn/throw-new-error': 'error'
 	}
 };

package/eslint/overrides-gatsby.js

@@ -87,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "2.4.0",
+	"version": "2.8.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.11.0",
-		"@typescript-eslint/parser": "5.11.0",
-		"eslint": "8.8.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.2.0",
 		"eslint-plugin-import": "2.25.4",
-		"eslint-plugin-jest": "26.1.0",
-		"eslint-plugin-jsdoc": "37.8.1",
+		"eslint-plugin-jest": "26.1.1",
+		"eslint-plugin-jsdoc": "37.9.4",
 		"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",
+		"eslint-plugin-unicorn": "41.0.0",
 		"markdownlint-cli": "0.31.1",
 		"postcss-scss": "4.0.3",
-		"stylelint": "14.4.0",
+		"stylelint": "14.5.1",
 		"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.16",
+		"@types/node": "17.0.18",
 		"stylelint-find-new-rules": "^3.0.4",
 		"typescript": "4.5.5"
 	}

package/stylelint/index.js

@@ -183,7 +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"
+		'function-no-unknown': null, // @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,