@foray1010/eslint-config 10.5.1 → 11.0.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [11.0.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.5.1...@foray1010/eslint-config@11.0.0) (2023-08-10)
+
+### ⚠ BREAKING CHANGES
+
+- **deps:** update prettier to v3
+- **deps:** require eslint ^8.38.0
+
+### Features
+
+- **deps:** update eslint-config-prettier to v9 ([5be09d4](https://github.com/foray1010/common-presets/commit/5be09d47bea41e79ea2887391ae80baa6b38eb8c))
+- **deps:** update ts and functional eslint plugin to v6 ([5d7b765](https://github.com/foray1010/common-presets/commit/5d7b7659c9e5b0a8603d3c57b06103741fb1fd0b))
+
+### Bug Fixes
+
+- **deps:** update dependency @eslint-community/eslint-plugin-eslint-comments to v4 ([#683](https://github.com/foray1010/common-presets/issues/683)) ([c50b32a](https://github.com/foray1010/common-presets/commit/c50b32a87158a519ffad8f430827410df0fa46d7))
+- **deps:** update dependency eslint-plugin-jest-dom to v5 ([#651](https://github.com/foray1010/common-presets/issues/651)) ([a8882a9](https://github.com/foray1010/common-presets/commit/a8882a9b4fdb2b34fd233d50e835eab05dba05ec))
+- **deps:** update dependency eslint-plugin-n to v16 ([85aace0](https://github.com/foray1010/common-presets/commit/85aace07945ffa1edaa163340063719220226467))
+- **deps:** update dependency eslint-plugin-unicorn to v47 ([2f6effe](https://github.com/foray1010/common-presets/commit/2f6effea8f83c31632bf37c49778019e835a09cb))
+- **deps:** update eslint-plugin-unicorn to v48 ([d930822](https://github.com/foray1010/common-presets/commit/d9308225b864eaf7d6304c83966e288f688186a7))
+- **deps:** update prettier to v3 ([4724464](https://github.com/foray1010/common-presets/commit/4724464c1c272df3eb686b168d836a9a696c11a2))
+
 ## [10.5.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.5.0...@foray1010/eslint-config@10.5.1) (2023-04-22)
 
 ### Bug Fixes

package/bases/base.mjs

@@ -14,16 +14,21 @@ import {
   typeScriptTestFileGlobs,
 } from '../constants.mjs'
 
-/** @returns {Promise<readonly import('eslint').Linter.FlatConfig[]>} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @returns {Promise<EslintConfig>} */
 async function generateTypeScriptConfig() {
   // typescript plugins are depended on `typescript` package
   if (!hasDep('typescript')) return []
 
+  /* eslint-disable import/no-unresolved */
   const eslintPluginTypescriptEslint = (
     await import('@typescript-eslint/eslint-plugin')
   ).default
-  const typescriptEslintParser = (await import('@typescript-eslint/parser'))
-    .default
+  const typescriptEslintParser =
+    // @ts-expect-error
+    (await import('@typescript-eslint/parser')).default
+  /* eslint-enable import/no-unresolved */
   const eslintPluginDeprecation = (await import('eslint-plugin-deprecation'))
     .default
   const eslintPluginFunctional = (await import('eslint-plugin-functional'))
@@ -49,7 +54,6 @@ async function generateTypeScriptConfig() {
         },
       },
       plugins: {
-        // @ts-expect-error
         '@typescript-eslint': eslintPluginTypescriptEslint,
         // @ts-expect-error
         deprecation: eslintPluginDeprecation,
@@ -116,8 +120,6 @@ async function generateTypeScriptConfig() {
         '@typescript-eslint/no-duplicate-enum-values': 'error',
         // need empty function for react context default value
         '@typescript-eslint/no-empty-function': 'off',
-        // encourage to check error type before use in catch clauses
-        '@typescript-eslint/no-implicit-any-catch': 'error',
         // when using typescript 5.0 with verbatimModuleSyntax flag on, compiler will not remove import statements with only inline type imports which lead to side effects
         '@typescript-eslint/no-import-type-side-effects': 'error',
         // enforce correct usage of `void` type
@@ -232,7 +234,6 @@ async function generateTypeScriptConfig() {
     {
       files: typeScriptTestFileGlobs,
       plugins: {
-        // @ts-expect-error
         '@typescript-eslint': eslintPluginTypescriptEslint,
         jest: eslintPluginJest,
       },
@@ -252,7 +253,7 @@ async function generateTypeScriptConfig() {
   ]
 }
 
-/** @type {import('eslint').Linter.FlatConfig} */
+/** @type {EslintConfig[number]} */
 const cjsConfig = {
   languageOptions: {
     globals: globals.commonjs,
@@ -264,7 +265,7 @@ const cjsConfig = {
   },
 }
 
-/** @type {import('eslint').Linter.FlatConfig} */
+/** @type {EslintConfig[number]} */
 const esmConfig = {
   languageOptions: {
     sourceType: 'module',
@@ -280,7 +281,7 @@ const esmConfig = {
   },
 }
 
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+/** @type {EslintConfig} */
 const baseConfig = [
   js.configs.recommended,
   {
@@ -409,18 +410,12 @@ const baseConfig = [
       // use with `unicorn/throw-new-error`
       // disallow builtins to be created without `new` operator, to be consistent with es6 class syntax
       'unicorn/new-for-builtins': 'error',
-      // `at()` is simpler to use in array and string
-      'unicorn/prefer-at': 'error',
-      // EventTarget works on both node.js and browsers, but EventEmitter only works on node.js
-      'unicorn/prefer-event-target': 'error',
       // some legacy projects still use commonjs
       'unicorn/prefer-module': 'off',
       // `querySelector` is slower than `getElementById`
       'unicorn/prefer-query-selector': 'off',
       // `Array.from(iterable)` is more readable than `[...iterable]`
       'unicorn/prefer-spread': 'off',
-      // it is cleaner than `.replace(//g)`
-      'unicorn/prefer-string-replace-all': 'error',
       // sometimes it is less readable using ternary expressions
       'unicorn/prefer-ternary': 'off',
       // webpack support on `top level await` is still experimental, and some legacy projects still use commonjs

package/bases/browser.mjs

@@ -1,13 +1,36 @@
+// @ts-expect-error
+import { hasDep } from '@foray1010/common-presets-utils'
 import restrictedGlobals from 'confusing-browser-globals'
 import eslintPluginCompat from 'eslint-plugin-compat'
 import eslintPluginImport from 'eslint-plugin-import'
-import eslintPluginJestDom from 'eslint-plugin-jest-dom'
 import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
 import globals from 'globals'
 
 import { testFileGlobs } from '../constants.mjs'
 
-/** @type {import('eslint').Linter.FlatConfig[]} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @returns {Promise<EslintConfig>} */
+async function generateJestDomConfig() {
+  // `eslint-plugin-jest-dom` depends on `@testing-library/dom` package
+  if (!hasDep('@testing-library/dom')) return []
+
+  const eslintPluginJestDom = (await import('eslint-plugin-jest-dom')).default
+
+  return [
+    {
+      files: testFileGlobs,
+      plugins: {
+        'jest-dom': eslintPluginJestDom,
+      },
+      rules: {
+        ...eslintPluginJestDom.configs['recommended']?.rules,
+      },
+    },
+  ]
+}
+
+/** @type {EslintConfig} */
 const browserConfig = [
   {
     languageOptions: {
@@ -30,14 +53,13 @@ const browserConfig = [
       'no-restricted-globals': ['error', ...restrictedGlobals],
     },
   },
+  ...(await generateJestDomConfig()),
   {
     files: testFileGlobs,
     plugins: {
-      'jest-dom': eslintPluginJestDom,
       'testing-library': eslintPluginTestingLibrary,
     },
     rules: {
-      ...eslintPluginJestDom.configs['recommended']?.rules,
       ...eslintPluginTestingLibrary.configs['dom']?.rules,
       // allow to use nodejs modules in tests
       'import/no-nodejs-modules': 'off',

package/bases/ignores.mjs

@@ -1,4 +1,6 @@
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @type {EslintConfig} */
 const ignoresConfig = [
   {
     // replace `.eslintignore`

package/bases/node.mjs

@@ -2,7 +2,9 @@
 import { isESM } from '@foray1010/common-presets-utils'
 import eslintPluginN from 'eslint-plugin-n'
 
-/** @type {import('eslint').Linter.FlatConfig} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @type {EslintConfig[number]} */
 const cjsConfig = {
   languageOptions: {
     globals: {
@@ -14,7 +16,7 @@ const cjsConfig = {
   },
 }
 
-/** @type {import('eslint').Linter.FlatConfig[]} */
+/** @type {EslintConfig} */
 const nodeConfig = [
   {
     plugins: {

package/bases/prettier.mjs

@@ -1,7 +1,9 @@
 import eslintConfigPrettier from 'eslint-config-prettier'
 import eslintPluginPrettier from 'eslint-plugin-prettier'
 
-/** @type {import('eslint').Linter.FlatConfig[]} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @type {EslintConfig} */
 const prettierConfig = [
   // should be placed at the end to override other configs
   {

package/bases/react.mjs

@@ -4,7 +4,9 @@ import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
 
 import { testFileGlobs } from '../constants.mjs'
 
-/** @type {import('eslint').Linter.FlatConfig[]} */
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @type {EslintConfig} */
 const reactConfig = [
   {
     languageOptions: {

package/index.mjs

@@ -6,21 +6,23 @@ import reactConfig from './bases/react.mjs'
 
 export * from './utils/applyConfig.mjs'
 
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+/** @typedef {import('./types/internal.d.ts').EslintConfig} EslintConfig */
+
+/** @type {EslintConfig} */
 export const eslintBrowserConfig = [
   ...baseConfig,
   ...browserConfig,
   ...prettierConfig,
 ]
 
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+/** @type {EslintConfig} */
 export const eslintNodeConfig = [
   ...baseConfig,
   ...nodeConfig,
   ...prettierConfig,
 ]
 
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+/** @type {EslintConfig} */
 export const eslintReactConfig = [
   ...baseConfig,
   ...browserConfig,

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "10.5.1",
+  "version": "11.0.0",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -20,40 +20,43 @@
     "type:check": "tsc"
   },
   "dependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": "^3.2.1",
-    "@eslint/js": "^8.36.0",
-    "@foray1010/common-presets-utils": "^7.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.0.0",
+    "@eslint/js": "^8.44.0",
+    "@foray1010/common-presets-utils": "^7.0.3",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.2.1",
     "confusing-browser-globals": "^1.0.10",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-compat": "^4.1.2",
     "eslint-plugin-deprecation": "^1.4.0",
-    "eslint-plugin-functional": "^5.0.8",
+    "eslint-plugin-functional": "^6.0.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^27.1.3",
-    "eslint-plugin-jest-dom": "^4.0.0",
-    "eslint-plugin-jsdoc": "^43.0.7",
-    "eslint-plugin-n": "^15.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-jest-dom": "^5.0.0",
+    "eslint-plugin-n": "^16.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.2.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-testing-library": "^5.10.2",
-    "eslint-plugin-unicorn": "^46.0.0",
+    "eslint-plugin-unicorn": "^48.0.0",
     "globals": "^13.19.0"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "1.0.0",
-    "@types/eslint": "8.37.0"
+    "@types/eslint": "8.44.2"
   },
   "peerDependencies": {
-    "eslint": "^8.36.0",
-    "prettier": "^2.0.0",
+    "@testing-library/dom": "^9.0.0",
+    "eslint": "^8.38.0",
+    "prettier": "^3.0.0",
     "typescript": "^5.0.2"
   },
   "peerDependenciesMeta": {
+    "@testing-library/dom": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     }
@@ -64,5 +67,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0bfecd900cd5d2e0b72ad9c3191c821f5708b51e"
+  "gitHead": "53eea83670d83a13b40cf0022f24badccfda681c"
 }

package/utils/applyConfig.mjs

@@ -2,23 +2,25 @@ import path from 'node:path'
 
 import { supportedFilesGlob } from '../constants.mjs'
 
+/** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
+
 /**
  * Extend the flat configs with default files and ignores
  * @param {{
  *   readonly filePrefixes: string | string[],
- *   readonly ignores?: string | string[] | undefined
+ *   readonly ignores?: string[] | undefined
  * }} options
- * @param {readonly import('eslint').Linter.FlatConfig[]} flatConfigs
- * @returns {readonly import('eslint').Linter.FlatConfig[]}
+ * @param {EslintConfig} eslintConfig
+ * @returns {EslintConfig}
  */
-export function applyConfig(options, flatConfigs) {
+export function applyConfig(options, eslintConfig) {
   const filePrefixes = [options.filePrefixes].flat()
   if (filePrefixes.length === 0) {
     throw new TypeError('filePrefixes must not be empty')
   }
 
   // Do not allow string such as "eslint:recommended" because it cannot be overridden by files/ignores
-  for (const config of flatConfigs) {
+  for (const config of eslintConfig) {
     if (typeof config === 'string') {
       throw new TypeError(
         `Cannot extend ${config} with files/ignores, use \`@eslint/js\` instead`,
@@ -30,7 +32,7 @@ export function applyConfig(options, flatConfigs) {
     }
   }
 
-  return flatConfigs.map((config) => {
+  return eslintConfig.map((config) => {
     const files = generateCombinations(filePrefixes, config.files)
     return {
       ...config,
@@ -42,18 +44,26 @@ export function applyConfig(options, flatConfigs) {
 
 /**
  * @param {string[]} prefixes
- * @param {string | string[] | undefined} originalGlobs
- * @returns {string | string[] | undefined}
+ * @param {EslintConfig[number]['files']} originalGlobs
+ * @returns {string[] | undefined}
  */
 function generateCombinations(prefixes, originalGlobs) {
   if (!originalGlobs || originalGlobs.length === 0) {
     return prefixes.map((prefix) => path.join(prefix, supportedFilesGlob))
   }
 
-  const originalGlobList = [originalGlobs].flat()
+  const verifiedOriginalGlobs = originalGlobs.filter(
+    /** @returns {originalGlob is string} */
+    (originalGlob) => typeof originalGlob === 'string',
+  )
+  if (originalGlobs.length !== verifiedOriginalGlobs.length) {
+    throw new TypeError(
+      `Do not support using non-string value in files/ignores`,
+    )
+  }
 
   return prefixes.flatMap((prefix) => {
-    return originalGlobList.flatMap((originalGlob) => {
+    return verifiedOriginalGlobs.flatMap((originalGlob) => {
       const signRegexp = /^!/
       const sign = originalGlob.match(signRegexp)?.[0] ?? ''
       return sign + path.join(prefix, originalGlob.replace(signRegexp, ''))