@remcohaszing/eslint 11.1.0 → 12.0.1

package/README.md

@@ -2,8 +2,8 @@
 
 > A strict ESLint configuration
 
-[![build status](https://github.com/remcohaszing/@remcohaszing/eslint/workflows/ci/badge.svg)](https://github.com/remcohaszing/@remcohaszing/eslint/actions)
-[![codecov](https://codecov.io/gh/remcohaszing/@remcohaszing/eslint/branch/main/graph/badge.svg)](https://codecov.io/gh/remcohaszing/@remcohaszing/eslint)
+[![build status](https://github.com/remcohaszing/eslint/workflows/ci/badge.svg)](https://github.com/remcohaszing/eslint/actions)
+[![codecov](https://codecov.io/gh/remcohaszing/eslint/branch/main/graph/badge.svg)](https://codecov.io/gh/remcohaszing/eslint)
 [![npm](https://img.shields.io/npm/v/@remcohaszing/eslint)](https://www.npmjs.com/package/@remcohaszing/eslint)
 [![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
@@ -74,9 +74,9 @@ enabled. Unfortunately, this makes ESLint slow. Enabling these rules is recommen
 projects only. To enable this, add the following to `eslint.config.js`:
 
 ```js
-import config, { typechecking } from '@remcohaszing/eslint'
+import { define, typechecking } from '@remcohaszing/eslint'
 
-export default [...config, ...typechecking]
+export default define(typechecking)
 ```
 
 ### Markdown
@@ -96,16 +96,15 @@ Rules can be disabled by adding an extra ESLint configuration item to the config
 example:
 
 ```js
-import config from '@remcohaszing/eslint'
+import { define } from '@remcohaszing/eslint'
 
-export default [
-  ...config,
+export default define([
   {
     rules: {
       'no-console': 'off'
     }
   }
-]
+])
 ```
 
 ## Ignored files
@@ -115,7 +114,7 @@ the patterns from `.gitignore`.
 
 ## Warnings
 
-All ESLint that are turned on will trigger error, not warnings. The notable exceptions is
+All ESLint that are turned on will trigger error, not warnings. The notable exception is
 `@typescript-eslint/no-deprecated`.
 
 This is to allow a smooth migration if a dependency decides to deprecate an API. To turn make

package/lib/config.js

@@ -2,6 +2,9 @@
  * @import {Linter} from 'eslint'
  */
 
+import { dirname, join } from 'node:path'
+
+import { includeIgnoreFile } from '@eslint/compat'
 import markdown from '@eslint/markdown'
 // @ts-expect-error
 import eslintCommunityEslintComments from '@eslint-community/eslint-plugin-eslint-comments'
@@ -19,11 +22,68 @@ import perfectionist from 'eslint-plugin-perfectionist'
 import { Alphabet } from 'eslint-plugin-perfectionist/alphabet'
 import prettier from 'eslint-plugin-prettier'
 import unicorn from 'eslint-plugin-unicorn'
+import findUp from 'find-up'
 import globals from 'globals'
 
-import { allowedProperties } from './allowedProperties.js'
-import { typesOnlyPackages } from './constants.js'
-import { getIgnorePatterns } from './getIgnorePatterns.js'
+/**
+ * These property names are allowed, because exist in commonly used specifications.
+ */
+const allowedProperties = [
+  // OAuth2
+  'access_token',
+  'client_id',
+  'client_secret',
+  'error_description',
+  'error_uri',
+  'expires_in',
+  'grant_type',
+  'redirect_uri',
+  'refresh_token',
+  'response_type',
+  'token_type',
+
+  // OpenID
+  'email_verified',
+  'id_token',
+
+  // Web app manifest
+  'background_color',
+  'iarc_rating_id',
+  'short_name',
+  'prefer_related_applications',
+  'related_applications',
+  'start_url',
+  'theme_color',
+
+  // React
+  '__html'
+]
+
+/**
+ * Known packages that export only type definitions, but which don’t contain a JavaScript file.
+ */
+const typesOnlyPackages = ['@fortawesome/fontawesome-common-types']
+
+/**
+ * Determine the default ignore pattern based on `.gitignore`.
+ *
+ * @returns {Linter.Config}
+ *   An array of ignore patterns accepted in an ESLint configuration.
+ */
+function getIgnorePatterns() {
+  const gitDir = findUp.sync('.git', { type: 'directory' })
+
+  if (!gitDir) {
+    return {}
+  }
+
+  const gitIgnorePath = join(dirname(gitDir), '.gitignore')
+  try {
+    return includeIgnoreFile(gitIgnorePath)
+  } catch {
+    return {}
+  }
+}
 
 const restrictedImports = [
   { name: 'node:assert', message: 'Use node:assert/strict instead.' },
@@ -67,7 +127,7 @@ const NON_COMPONENT_FUNCTION = 'FunctionDeclaration[id.name=/^[a-z]/]'
 const METHOD_DEFINITION = 'MethodDefinition'
 
 const config = defineConfig([
-  getIgnorePatterns() ?? {},
+  getIgnorePatterns(),
   {
     name: 'base',
     languageOptions: {
@@ -198,7 +258,7 @@ const config = defineConfig([
         'always',
         {
           ignoreConsecutiveComments: true,
-          ignorePattern: /^\s*(c8|type-coverage:|webpack\w)/.source
+          ignorePattern: /^\s*(c8|type-coverage:|webpack\w|([\w.-]+\.\w+$))/.source
         }
       ],
       'class-methods-use-this': 'error',
@@ -238,7 +298,7 @@ const config = defineConfig([
       'no-dupe-else-if': 'error',
       'no-dupe-keys': 'error',
       'no-duplicate-case': 'error',
-      'no-duplicate-imports': ['error', { includeExports: true }],
+      'no-duplicate-imports': ['error', { allowSeparateTypeImports: true, includeExports: true }],
       'no-else-return': ['error', { allowElseIf: false }],
       'no-empty': 'error',
       'no-empty-character-class': 'error',
@@ -320,6 +380,7 @@ const config = defineConfig([
       'no-shadow-restricted-names': 'error',
       'no-this-before-super': 'error',
       'no-throw-literal': 'error',
+      'no-unassigned-vars': 'error',
       'no-undef': 'error',
       'no-undef-init': 'error',
       'no-underscore-dangle': 'error',
@@ -420,7 +481,30 @@ const config = defineConfig([
       ],
       '@stylistic/multiline-comment-style': ['error', 'separate-lines'],
       '@stylistic/no-tabs': ['error', { allowIndentationTabs: true }],
-      '@stylistic/padding-line-between-statements': 'error',
+      '@stylistic/padding-line-between-statements': [
+        'error',
+        {
+          blankLine: 'always',
+          prev: ['cjs-import', 'import'],
+          next: '*'
+        },
+        {
+          blankLine: 'any',
+          prev: ['cjs-import', 'import'],
+          next: ['cjs-import', 'import']
+        },
+
+        {
+          blankLine: 'always',
+          prev: 'function',
+          next: '*'
+        },
+        {
+          blankLine: 'always',
+          prev: '*',
+          next: 'function'
+        }
+      ],
       '@stylistic/quotes': ['error', 'single', { avoidEscape: true, ignoreStringLiterals: true }],
       '@stylistic/spaced-comment': [
         'error',
@@ -432,15 +516,11 @@ const config = defineConfig([
       ],
 
       // https://github.com/un-ts/eslint-plugin-import-x
-      'import-x/consistent-type-specifier-style': ['error', 'prefer-inline'],
+      'import-x/consistent-type-specifier-style': 'error',
       'import-x/export': 'error',
       'import-x/extensions': ['error', 'ignorePackages'],
       'import-x/first': 'error',
-      'import-x/named': 'error',
-      'import-x/namespace': 'error',
-      'import-x/newline-after-import': 'error',
       'import-x/no-absolute-path': 'error',
-      'import-x/no-amd': 'error',
       'import-x/no-anonymous-default-export': [
         'error',
         {
@@ -454,7 +534,6 @@ const config = defineConfig([
           allowObject: true
         }
       ],
-      'import-x/no-duplicates': ['error', { 'prefer-inline': true }],
       'import-x/no-extraneous-dependencies': [
         'error',
         {
@@ -478,7 +557,6 @@ const config = defineConfig([
         }
       ],
       'import-x/no-useless-path-segments': 'error',
-      'import-x/no-webpack-loader-syntax': 'error',
 
       // https://github.com/dangreenisrael/eslint-plugin-jest-formatting
       'jest-formatting/padding-around-after-all-blocks': 'error',
@@ -492,7 +570,7 @@ const config = defineConfig([
       'jsdoc/check-access': 'error',
       'jsdoc/check-indentation': [
         'error',
-        { excludeTags: ['example', 'param', 'property', 'returns', 'throws', 'todo'] }
+        { excludeTags: ['example', 'param', 'property', 'returns', 'template', 'throws', 'todo'] }
       ],
       'jsdoc/check-line-alignment': ['error', 'never', { wrapIndent: '  ' }],
       'jsdoc/check-param-names': ['error', { checkDestructured: false }],
@@ -530,7 +608,31 @@ const config = defineConfig([
           contexts: [
             {
               comment: 'JsdocBlock:has(JsdocTag[tag=typedef][parsedType.value=/object/i])',
-              message: 'Omit the object type from typedef'
+              message: 'Omit the object type from @typedef'
+            },
+
+            // https://github.com/gajus/eslint-plugin-jsdoc/issues/1314
+            {
+              comment: 'JsdocBlock:has(JsdocTag:has(JsdocTypeImport))',
+              context: 'any',
+              message: 'Use @import tag over import() statements'
+            },
+
+            // https://github.com/gajus/eslint-plugin-jsdoc/issues/1445
+            {
+              comment: 'JsdocBlock:has(JsdocTag[tag=typedef]):has(JsdocTag[tag=callback])',
+              context: 'any',
+              message: 'Use separate blocks for @typedef and @callback'
+            },
+            {
+              comment: 'JsdocBlock:has(JsdocTag[tag=typedef] ~ JsdocTag[tag=typedef])',
+              context: 'any',
+              message: 'Use separate blocks for multiple @typedef tags'
+            },
+            {
+              comment: 'JsdocBlock:has(JsdocTag[tag=callback] ~ JsdocTag[tag=callback])',
+              context: 'any',
+              message: 'Use separate blocks for  multiple @typedef tags'
             }
           ]
         }
@@ -601,11 +703,19 @@ const config = defineConfig([
         {
           type: 'custom',
           alphabet,
-          internalPattern: ['^#'],
+          internalPattern: [],
           groups: [
             'side-effect',
+            'type-builtin',
+            'type-external',
+            'type-subpath',
+            'type-internal',
+            'type-parent',
+            { newlinesBetween: 'never' },
+            ['type-sibling', 'type-index'],
             'builtin',
             'external',
+            'subpath',
             'internal',
             'parent',
             { newlinesBetween: 'never' },
@@ -656,6 +766,7 @@ const config = defineConfig([
             'node:fs/promises': { named: true },
             'node:os': { named: true },
             'node:path': { named: true },
+            'node:test': { named: true },
             'node:url': { named: true },
             'node:util': { named: true },
             'node:zlib': { named: true },
@@ -671,7 +782,6 @@ const config = defineConfig([
       'unicorn/no-accessor-recursion': 'error',
       'unicorn/no-array-for-each': 'error',
       'unicorn/no-array-method-this-argument': 'error',
-      'unicorn/no-array-push-push': 'error',
       'unicorn/no-array-reduce': 'error',
       'unicorn/no-await-in-promise-methods': 'error',
       'unicorn/no-console-spaces': 'error',
@@ -682,7 +792,6 @@ const config = defineConfig([
       'unicorn/no-instanceof-builtins': 'error',
       'unicorn/no-invalid-fetch-options': 'error',
       'unicorn/no-invalid-remove-event-listener': 'error',
-      'unicorn/no-length-as-slice-end': 'error',
       'unicorn/no-lonely-if': 'error',
       'unicorn/no-named-default': 'error',
       'unicorn/no-negated-condition': 'error',
@@ -693,9 +802,13 @@ const config = defineConfig([
       'unicorn/no-static-only-class': 'error',
       'unicorn/no-this-assignment': 'error',
       'unicorn/no-typeof-undefined': 'error',
+      'unicorn/no-unnecessary-array-flat-depth': 'error',
+      'unicorn/no-unnecessary-array-splice-count': 'error',
       'unicorn/no-unnecessary-await': 'error',
+      'unicorn/no-unnecessary-slice-end': 'error',
       'unicorn/no-unreadable-iife': 'error',
       'unicorn/no-unused-properties': 'error',
+      'unicorn/no-useless-error-capture-stack-trace': 'error',
       'unicorn/no-useless-fallback-in-spread': 'error',
       'unicorn/no-useless-length-check': 'error',
       'unicorn/no-useless-promise-resolve-reject': 'error',
@@ -711,6 +824,7 @@ const config = defineConfig([
       'unicorn/prefer-array-some': 'error',
       'unicorn/prefer-at': 'error',
       'unicorn/prefer-blob-reading-methods': 'error',
+      'unicorn/prefer-class-fields': 'error',
       'unicorn/prefer-date-now': 'error',
       'unicorn/prefer-default-parameters': 'error',
       'unicorn/prefer-dom-node-append': 'error',
@@ -720,6 +834,7 @@ const config = defineConfig([
       'unicorn/prefer-event-target': 'error',
       'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
       'unicorn/prefer-global-this': 'error',
+      'unicorn/prefer-import-meta-properties': 'error',
       'unicorn/prefer-includes': 'error',
       'unicorn/prefer-json-parse-buffer': 'error',
       'unicorn/prefer-keyboard-event-key': 'error',
@@ -739,6 +854,7 @@ const config = defineConfig([
       'unicorn/prefer-regexp-test': 'error',
       'unicorn/prefer-set-has': 'error',
       'unicorn/prefer-set-size': 'error',
+      'unicorn/prefer-single-call': 'error',
       'unicorn/prefer-string-replace-all': 'error',
       'unicorn/prefer-string-slice': 'error',
       'unicorn/prefer-string-starts-ends-with': 'error',
@@ -748,6 +864,7 @@ const config = defineConfig([
       'unicorn/prefer-top-level-await': 'error',
       'unicorn/prefer-type-error': 'error',
       'unicorn/relative-url-style': 'error',
+      'unicorn/require-module-specifiers': 'error',
       'unicorn/require-post-message-target-origin': 'error',
       'unicorn/switch-case-braces': ['error', 'avoid'],
       'unicorn/template-indent': 'error',
@@ -1049,6 +1166,7 @@ export const typechecking = defineConfig([
       '@typescript-eslint/no-unnecessary-template-expression': 'error',
       '@typescript-eslint/no-unnecessary-type-arguments': 'error',
       '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+      '@typescript-eslint/no-unnecessary-type-conversion': 'error',
       '@typescript-eslint/no-unsafe-argument': 'error',
       '@typescript-eslint/no-unsafe-assignment': 'error',
       '@typescript-eslint/no-unsafe-call': 'error',
@@ -1091,3 +1209,15 @@ export const typechecking = defineConfig([
     }
   }
 ])
+
+/**
+ * Define an ESLint configuration that extends the default export.
+ *
+ * @param {Linter.Config | Linter.Config[]} overrides
+ *   ESLint configuration overrides.
+ * @returns {Linter.Config[]}
+ *   The full ESLint configuration.
+ */
+export function define(overrides) {
+  return [...config, ...defineConfig(overrides)]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remcohaszing/eslint",
-  "version": "11.1.0",
+  "version": "12.0.1",
   "description": "A strict ESLint configuration.",
   "keywords": [
     "eslint",
@@ -31,18 +31,18 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.0.0",
     "@eslint/compat": "^1.0.0",
-    "@eslint/markdown": "^6.0.0",
-    "@stylistic/eslint-plugin": "^4.0.0",
+    "@eslint/markdown": "^7.0.0",
+    "@stylistic/eslint-plugin": "^5.0.0",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "confusing-browser-globals": "^1.0.0",
     "eslint-plugin-import-x": "^4.0.0",
     "eslint-plugin-jest-formatting": "^3.0.0",
-    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-jsdoc": "^54.0.0",
     "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-perfectionist": "^4.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-unicorn": "^58.0.0",
+    "eslint-plugin-unicorn": "^60.0.0",
     "find-up": "^5.0.0"
   },
   "devDependencies": {
@@ -50,6 +50,7 @@
     "prettier-plugin-packagejson": "^2.0.0",
     "remark-cli": "^12.0.0",
     "remark-preset-remcohaszing": "^3.0.0",
+    "type-fest": "^4.0.0",
     "typescript": "^5.0.0"
   },
   "peerDependencies": {

package/types/config.d.ts

@@ -1,5 +1,14 @@
+/**
+ * Define an ESLint configuration that extends the default export.
+ *
+ * @param {Linter.Config | Linter.Config[]} overrides
+ *   ESLint configuration overrides.
+ * @returns {Linter.Config[]}
+ *   The full ESLint configuration.
+ */
+export function define(overrides: Linter.Config | Linter.Config[]): Linter.Config[];
 export default config;
 export const typechecking: Linter.Config<Linter.RulesRecord>[];
-declare const config: Linter.Config<Linter.RulesRecord>[];
 import type { Linter } from 'eslint';
+declare const config: Linter.Config<Linter.RulesRecord>[];
 //# sourceMappingURL=config.d.ts.map

package/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.js"],"names":[],"mappings":";AA0/BA,+DA0EE;AAhgCF,0DAk7BE;4BAr/BuB,QAAQ"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.js"],"names":[],"mappings":"AA4rCA;;;;;;;GAOG;AACH,kCALW,aAAa,GAAG,aAAa,EAAE,GAE7B,aAAa,EAAE,CAK3B;;AAvFD,+DA2EE;4BAzrCuB,QAAQ;AA+HjC,0DA2+BE"}

package/lib/allowedProperties.js

@@ -1,33 +0,0 @@
-/**
- * These property names are allowed, because exist in commonly used specifications.
- */
-export const allowedProperties = [
-  // OAuth2
-  'access_token',
-  'client_id',
-  'client_secret',
-  'error_description',
-  'error_uri',
-  'expires_in',
-  'grant_type',
-  'redirect_uri',
-  'refresh_token',
-  'response_type',
-  'token_type',
-
-  // OpenID
-  'email_verified',
-  'id_token',
-
-  // Web app manifest
-  'background_color',
-  'iarc_rating_id',
-  'short_name',
-  'prefer_related_applications',
-  'related_applications',
-  'start_url',
-  'theme_color',
-
-  // React
-  '__html'
-]

package/lib/constants.js

@@ -1,17 +0,0 @@
-/**
- * Known packages in on DefinitelyTyped that don’t describe an npm package.
- */
-export const dtOnlyPackages = [
-  'estree',
-  'estree-jsx',
-  'hast',
-  'mdast',
-  'unist',
-  'web-app-manifest',
-  'xast'
-]
-
-/**
- * Known packages that export only type definitions, but which don’t contain a JavaScript file.
- */
-export const typesOnlyPackages = ['@fortawesome/fontawesome-common-types']

package/lib/getIgnorePatterns.js

@@ -1,27 +0,0 @@
-/**
- * @import { Linter } from 'eslint'
- */
-
-import { dirname, join } from 'node:path'
-
-import { includeIgnoreFile } from '@eslint/compat'
-import findUp from 'find-up'
-
-/**
- * Determine the default ignore pattern based on `.gitignore`.
- *
- * @returns {Linter.Config | undefined}
- *   An array of ignore patterns accepted in an ESLint configuration.
- */
-export function getIgnorePatterns() {
-  const gitDir = findUp.sync('.git', { type: 'directory' })
-
-  if (gitDir) {
-    const gitIgnorePath = join(dirname(gitDir), '.gitignore')
-    try {
-      return includeIgnoreFile(gitIgnorePath)
-    } catch {
-      // Do nothing
-    }
-  }
-}

package/types/allowedProperties.d.ts

@@ -1,5 +0,0 @@
-/**
- * These property names are allowed, because exist in commonly used specifications.
- */
-export const allowedProperties: string[];
-//# sourceMappingURL=allowedProperties.d.ts.map

package/types/allowedProperties.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"allowedProperties.d.ts","sourceRoot":"","sources":["../lib/allowedProperties.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,yCA6BC"}

package/types/constants.d.ts

@@ -1,9 +0,0 @@
-/**
- * Known packages in on DefinitelyTyped that don’t describe an npm package.
- */
-export const dtOnlyPackages: string[];
-/**
- * Known packages that export only type definitions, but which don’t contain a JavaScript file.
- */
-export const typesOnlyPackages: string[];
-//# sourceMappingURL=constants.d.ts.map

package/types/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../lib/constants.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,sCAQC;AAED;;GAEG;AACH,yCAA0E"}

package/types/getIgnorePatterns.d.ts

@@ -1,9 +0,0 @@
-/**
- * Determine the default ignore pattern based on `.gitignore`.
- *
- * @returns {Linter.Config | undefined}
- *   An array of ignore patterns accepted in an ESLint configuration.
- */
-export function getIgnorePatterns(): Linter.Config | undefined;
-import type { Linter } from 'eslint';
-//# sourceMappingURL=getIgnorePatterns.d.ts.map

package/types/getIgnorePatterns.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getIgnorePatterns.d.ts","sourceRoot":"","sources":["../lib/getIgnorePatterns.js"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,qCAHa,aAAa,GAAG,SAAS,CAcrC;4BAzB0B,QAAQ"}