linter-bundle 6.2.2 → 7.0.0

package/eslint/overrides-gatsby.cjs

@@ -1,108 +0,0 @@
-/**
- * @file Settings for Gatsby-based projects.
- *
- */
-
-module.exports = {
-	overrides: [
-		{
-			files: ['*.ts', '*.tsx'],
-			rules: {
-				/**
-				 * ./rules
-				 */
-				'no-global-undefined-check': 'error',
-
-				/**
-				 * eslint
-				 * @see https://eslint.org/docs/rules/
-				 */
-				'no-restricted-imports': ['error', {
-					paths: [{
-						name: '@reach/router',
-						importNames: ['useNavigate'],
-						message: 'Use "import { navigate } from \'gatsby\';" instead of "const navigate = useNavigate();"'
-					}]
-				}],
-
-				/**
-				 * typescript-eslint
-				 * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules
-				 */
-				'@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
-				 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
-				 */
-				'unicorn/string-content': ['error', {
-					patterns: {
-						// '\\.\\.\\.': '…', // @todo Does not support graphql-template strings. Report that as bug!
-						// eslint-disable-next-line unicorn/string-content -- If not disabled, the rule would report it's own disable-patterns.
-						'->': '→'
-					}
-				}]
-			}
-		},
-		{
-			files: ['*.tsx'],
-			settings: {
-				linkComponents: [
-					{ name: 'Link', linkAttribute: 'to' }
-				]
-			},
-			rules: {
-				/**
-				 * eslint-plugin-unicorn
-				 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
-				 */
-				'unicorn/filename-case': ['off', { // Disabled in favour of the linter-bundle `files` task
-					cases: {
-						camelCase: true,
-						pascalCase: true
-					},
-					ignore: [
-						/([A-Za-z0-9]?[a-z0-9]+)*[A-Z]{2,4}([A-Za-z0-9]?[a-z0-9]+)*/u // Up to 4 Characters can be upper-case in a row (e.g. in `prepareDOM` or `SVGIcon`)
-					]
-				}]
-			}
-		},
-		{
-			files: ['src/pages/*.tsx'],
-			rules: {
-				/**
-				 * eslint-plugin-import
-				 * @see https://github.com/import-js/eslint-plugin-import
-				 */
-				'import/no-default-export': 'off',
-				'import/no-unused-modules': ['error', { missingExports: true }],
-
-				/**
-				 * eslint-plugin-unicorn
-				 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
-				 */
-				'unicorn/filename-case': ['off', { // Disabled in favour of the linter-bundle `files` task
-					cases: {
-						kebabCase: true
-					}
-				}]
-			}
-		},
-		{
-			files: ['gatsby-browser.js'],
-			rules: {
-				/**
-				 * eslint-plugin-n
-				 * @see https://github.com/eslint-community/eslint-plugin-n
-				 */
-				'n/no-unsupported-features/es-syntax': 'off'
-			}
-		}
-	]
-};

package/eslint/overrides-javascript-lazy.cjs

@@ -1,27 +0,0 @@
-/**
- * @file Extends `./overrides-javascript` but ignores unsafe types.
- */
-
-const overridesJavaScript = require('./overrides-javascript.cjs');
-
-module.exports = {
-	...overridesJavaScript,
-	overrides: [
-		...overridesJavaScript.overrides,
-		{
-			files: ['*.js', '*.cjs', '*.mjs'],
-			rules: {
-				/**
-				 * typescript-eslint
-				 *
-				 * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules
-				 */
-				'@typescript-eslint/no-unsafe-argument': 'off',
-				'@typescript-eslint/no-unsafe-assignment': 'off',
-				'@typescript-eslint/no-unsafe-call': 'off',
-				'@typescript-eslint/no-unsafe-member-access': 'off',
-				'@typescript-eslint/no-unsafe-return': 'off'
-			}
-		}
-	]
-};

package/eslint/overrides-javascript.cjs

@@ -1,121 +0,0 @@
-/**
- * @file Settings for JavaScript (Node.js) files.
- */
-
-module.exports = {
-	overrides: [
-		{
-			files: ['*.js', '*.cjs', '*.mjs'],
-			env: {
-				node: true,
-				es6: true
-			},
-			plugins: ['n'],
-			rules: {
-				/**
-				 * eslint
-				 *
-				 * @see https://eslint.org/docs/rules/
-				 */
-				'max-lines-per-function': 'off',
-				'no-undef': 'error',
-
-				/**
-				 * typescript-eslint
-				 *
-				 * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules
-				 */
-				'@typescript-eslint/explicit-function-return-type': 'off', // Requires type information (@see https://github.com/typescript-eslint/typescript-eslint/issues/906)
-				'@typescript-eslint/explicit-member-accessibility': 'off', // @todo This function should also consider JSDoc @public/@private, but it doesn't do that yet, so create an ticket.
-				'@typescript-eslint/naming-convention': 'off', // Requires type information
-				'@typescript-eslint/no-implicit-any-catch': 'off', // @todo What's the correct way to define the type of the error-parameter in js files?
-				'@typescript-eslint/no-require-imports': 'off', // Requires type information
-				'@typescript-eslint/no-unsafe-assignment': 'off', // @todo Reactivate after bug in @typescript-eslint is fixed (@see https://github.com/typescript-eslint/typescript-eslint/issues/1943)
-				'@typescript-eslint/no-var-requires': 'off', // Requires type information
-				'@typescript-eslint/triple-slash-reference': 'off', // Required to make use of *.d.ts files
-
-				/**
-				 * eslint-plugin-import
-				 *
-				 * @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',
-				'import/dynamic-import-chunkname': 'off',
-
-				/**
-				 * eslint-plugin-n
-				 *
-				 * @see https://github.com/eslint-community/eslint-plugin-n
-				 */
-				'n/callback-return': 'error',
-				'n/exports-style': 'error',
-				'n/file-extension-in-import': 'error',
-				'n/global-require': 'off',
-				'n/handle-callback-err': 'error',
-				'n/no-callback-literal': 'error',
-				'n/no-deprecated-api': 'error',
-				'n/no-exports-assign': 'error',
-				'n/no-extraneous-import': 'error',
-				'n/no-extraneous-require': 'error',
-				'n/no-missing-import': 'error',
-				'n/no-missing-require': 'error',
-				'n/no-mixed-requires': 'error',
-				'n/no-new-require': 'error',
-				'n/no-path-concat': 'error',
-				'n/no-process-env': 'error',
-				'n/no-process-exit': 'error',
-				'n/no-restricted-import': 'error',
-				'n/no-restricted-require': 'error',
-				'n/no-sync': 'off', // Since the .js files are used in the CLI, preventing the use of sync functions is not required
-				'n/no-unpublished-bin': 'error',
-				'n/no-unpublished-import': 'error',
-				'n/no-unpublished-require': 'off', // Since we use .js files only for the dev-environment, we don't need this rule
-				'n/no-unsupported-features/es-builtins': 'error',
-				'n/no-unsupported-features/es-syntax': 'error',
-				'n/no-unsupported-features/node-builtins': 'error',
-				'n/prefer-global/buffer': 'error',
-				'n/prefer-global/console': 'error',
-				'n/prefer-global/process': 'error',
-				'n/prefer-global/text-decoder': 'error',
-				'n/prefer-global/text-encoder': 'error',
-				'n/prefer-global/url-search-params': 'error',
-				'n/prefer-global/url': 'error',
-				'n/prefer-promises/dns': 'error',
-				'n/prefer-promises/fs': 'error',
-				'n/process-exit-as-throw': 'error',
-				'n/shebang': 'error',
-
-				/**
-				 * eslint-plugin-unicorn
-				 *
-				 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
-				 */
-				'unicorn/filename-case': ['off', { // Disabled in favour of the linter-bundle `files` task
-					cases: {
-						kebabCase: true
-					}
-				}],
-				'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/text-encoding-identifier-case': 'off'
-			}
-		},
-		{
-			files: ['*.mjs'],
-			rules: {
-				'unicorn/prefer-top-level-await': 'error'
-			}
-		},
-		{
-			files: ['./*.js'],
-			rules: {
-				'unicorn/prefer-module': 'off'
-			}
-		}
-	]
-};

package/eslint/overrides-jest.cjs

@@ -1,144 +0,0 @@
-/**
- * @file Settings for Jest based unit tests.
- */
-
-const jestVersion = (() => {
-	try {
-		// eslint-disable-next-line n/no-missing-require, import/no-dynamic-require -- If "overrides-jest" is used, "jest" should be installed, and it should be searched in the working directory of the process.
-		const version = require(require.resolve('jest', { paths: [process.cwd()] })).getVersion().split('.')[0];
-
-		process.stdout.write(`Detected Jest version: ${version}\n\n`);
-
-		return version;
-	}
-	catch {
-		process.stderr.write('No Jest version detected\n\n');
-
-		return 'detect';
-	}
-})();
-
-module.exports = {
-	overrides: [
-		{
-			files: ['**/__tests__/**/*.[jt]s', '**/?(*.)+(spec|test).[jt]s'],
-			env: {
-				jest: true
-			},
-			settings: {
-				jest: {
-					version: jestVersion
-				}
-			},
-			plugins: ['jest'],
-			rules: {
-				/**
-				 * eslint
-				 *
-				 * @see https://eslint.org/docs/rules/
-				 */
-				'max-lines': 'off',
-				'max-lines-per-function': 'off',
-
-				/**
-				 * typescript-eslint
-				 *
-				 * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules
-				 */
-				'@typescript-eslint/ban-ts-comment': ['error', {
-					'ts-expect-error': false
-				}],
-
-				/**
-				 * eslint-plugin-import
-				 *
-				 * @see https://github.com/import-js/eslint-plugin-import
-				 */
-				'import/no-unassigned-import': 'error',
-
-				/**
-				 * eslint-plugin-jest
-				 *
-				 * @see https://github.com/jest-community/eslint-plugin-jest/tree/master/docs/rules
-				 */
-				'jest/consistent-test-it': 'error',
-				'jest/expect-expect': 'error',
-				'jest/prefer-lowercase-title': ['error', { ignore: ['describe'] }],
-				'jest/max-expects': 'error',
-				'jest/max-nested-describe': 'error',
-				'jest/no-alias-methods': 'error',
-				'jest/no-commented-out-tests': 'error',
-				'jest/no-conditional-expect': 'error',
-				'jest/no-conditional-in-test': 'error',
-				'jest/no-confusing-set-timeout': 'error',
-				'jest/no-deprecated-functions': 'error',
-				'jest/no-disabled-tests': 'error',
-				'jest/no-done-callback': 'error',
-				'jest/no-duplicate-hooks': 'error',
-				'jest/no-export': 'error',
-				'jest/no-focused-tests': 'error',
-				'jest/no-hooks': ['error', { allow: ['beforeEach', 'afterEach', 'afterAll'] }],
-				'jest/no-identical-title': 'error',
-				'jest/no-interpolation-in-snapshots': 'error',
-				'jest/no-jasmine-globals': 'error',
-				'jest/no-large-snapshots': 'error',
-				'jest/no-mocks-import': 'error',
-				'jest/no-restricted-jest-methods': 'off', // Right now, there are no specific restrictions
-				'jest/no-restricted-matchers': ['error', {
-					resolves: 'Use `expect(await promise)` instead.',
-					toBeFalsy: 'Avoid `toBeFalsy`',
-					toBeTruthy: 'Avoid `toBeTruthy`',
-					toMatchSnapshot: 'Use `toMatchInlineSnapshot()` instead',
-					toThrowErrorMatchingSnapshot: 'Use `toThrowErrorMatchingInlineSnapshot()` instead'
-				}],
-				'jest/no-standalone-expect': 'error',
-				'jest/no-test-prefixes': 'error',
-				'jest/no-test-return-statement': 'error',
-				'jest/prefer-called-with': 'error',
-				'jest/prefer-expect-assertions': ['error', { onlyFunctionsWithAsyncKeyword: true }],
-				'jest/prefer-expect-resolves': 'off', // We prefer `expect(await promise)` enforced by 'jest/no-restricted-matchers'
-				'jest/prefer-hooks-in-order': 'error',
-				'jest/prefer-hooks-on-top': 'error',
-				'jest/prefer-comparison-matcher': 'error',
-				'jest/prefer-each': 'error',
-				'jest/prefer-equality-matcher': 'error',
-				'jest/prefer-mock-promise-shorthand': 'error',
-				'jest/prefer-snapshot-hint': 'error',
-				'jest/prefer-spy-on': 'error',
-				'jest/prefer-strict-equal': 'error',
-				'jest/prefer-to-be': 'error',
-				'jest/prefer-to-contain': 'error',
-				'jest/prefer-to-have-length': 'error',
-				'jest/prefer-todo': 'error',
-				'jest/require-hook': 'error',
-				'jest/require-top-level-describe': 'error',
-				'jest/require-to-throw-message': 'error',
-				'jest/unbound-method': 'error',
-				'jest/valid-describe-callback': 'error',
-				'jest/valid-expect-in-promise': 'error',
-				'jest/valid-expect': 'error',
-				'jest/valid-title': 'error'
-			}
-		},
-		{
-			files: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
-			env: {
-				jest: true
-			},
-			settings: {
-				jest: {
-					version: jestVersion
-				}
-			},
-			plugins: ['jest'],
-			rules: {
-				/**
-				 * eslint-plugin-jest
-				 *
-				 * @see https://github.com/jest-community/eslint-plugin-jest/tree/master/docs/rules
-				 */
-				'jest/no-untyped-mock-factory': 'error'
-			}
-		}
-	]
-};

package/eslint/overrides-jsdoc.cjs

@@ -1,94 +0,0 @@
-/**
- * @file Settings for JSDoc comments in JavaScript (Node.js) files.
- */
-
-module.exports = {
-	overrides: [
-		{
-			files: ['*.js', '*.cjs', '*.mjs'],
-			env: {
-				node: true,
-				es6: true
-			},
-			plugins: ['jsdoc'],
-			settings: {
-				jsdoc: {
-					mode: 'typescript',
-					exemptDestructuredRootsFromChecks: true
-				}
-			},
-			rules: {
-				/**
-				 * "eslint-plugin-jsdoc" rules
-				 * @see https://github.com/gajus/eslint-plugin-jsdoc
-				 */
-				'jsdoc/check-access': 'error',
-				'jsdoc/check-alignment': 'error',
-				'jsdoc/check-examples': 'off', // @todo Need to be configured to allow text-based examples
-				'jsdoc/check-indentation': ['off', { excludeTags: ['typedef'] }], // @todo Why is this disabled?
-				'jsdoc/check-param-names': 'error',
-				'jsdoc/check-syntax': 'error',
-				'jsdoc/check-line-alignment': 'error',
-				'jsdoc/check-tag-names': 'error',
-				'jsdoc/check-types': 'error',
-				'jsdoc/check-values': 'error',
-				'jsdoc/empty-tags': 'error',
-				'jsdoc/implements-on-classes': 'error',
-				'jsdoc/imports-as-dependencies': 'off', // @todo Doesn't cover `peerDependencies` yet. As of v46.2.5 it should cover Node.js modules (like `child_process`), which must be checked, before activation.
-				'jsdoc/informative-docs': 'error',
-				'jsdoc/match-description': 'error',
-				'jsdoc/match-name': 'off',
-				'jsdoc/multiline-blocks': ['error', { noSingleLineBlocks: true, singleLineTags: ['lends', 'type', 'typedef'], noFinalLineText: false }],
-				'jsdoc/no-bad-blocks': 'error',
-				'jsdoc/no-blank-blocks': 'error',
-				'jsdoc/no-defaults': 'off',
-				'jsdoc/no-missing-syntax': 'off',
-				'jsdoc/no-multi-asterisks': ['error', { preventAtEnd: false }],
-				'jsdoc/no-restricted-syntax': 'off',
-				'jsdoc/no-types': 'off',
-				'jsdoc/no-undefined-types': ['error', { definedTypes: ['void', 'never', 'Readonly'] }],
-				'jsdoc/require-description-complete-sentence': 'off', // @todo Doesn't work correctly (e.g. the `g` of `e.g.` is interpreted as separate sentence).
-				'jsdoc/require-description': 'error',
-				'jsdoc/require-example': 'off',
-				'jsdoc/require-file-overview': 'error',
-				'jsdoc/require-hyphen-before-param-description': 'error',
-				'jsdoc/require-jsdoc': ['error', { minLineCount: 2 }],
-				'jsdoc/require-param-description': 'error',
-				'jsdoc/require-param-name': 'error',
-				'jsdoc/require-param-type': 'error',
-				'jsdoc/require-param': 'error',
-				'jsdoc/require-property': 'error',
-				'jsdoc/require-returns-check': 'error',
-				'jsdoc/require-returns-description': 'error',
-				'jsdoc/require-returns-type': 'error',
-				'jsdoc/require-returns': ['error', { forceReturnsWithAsync: true }],
-				'jsdoc/require-throws': 'error',
-				'jsdoc/require-yields': 'error',
-				'jsdoc/require-yields-check': 'error',
-				'jsdoc/tag-lines': ['error', 'always', {
-					tags: {
-						example: { lines: 'always' },
-						file: { lines: 'always' },
-						fileOverview: { lines: 'always' },
-						license: { lines: 'always' },
-						param: { lines: 'never' },
-						private: { lines: 'never' },
-						property: { lines: 'never' },
-						protected: { lines: 'never' },
-						public: { lines: 'never' },
-						returns: { lines: 'never' },
-						see: { lines: 'any' },
-						template: { lines: 'never' },
-						throws: { lines: 'never' },
-						typedef: { lines: 'never' }
-					},
-					startLines: null,
-					endLines: null,
-					applyToEndTag: false
-				}],
-				'jsdoc/text-escaping': 'off', // Right now, there is no description of this rule available on the page. Only the discussion here: https://github.com/gajus/eslint-plugin-jsdoc/issues/864
-				'jsdoc/valid-types': 'off' // Checked by TypeScript
-			}
-		}
-	]
-};