@foray1010/eslint-config 9.2.0 → 10.0.1

package/bases/prettier.mjs

@@ -0,0 +1,18 @@
+import eslintConfigPrettier from 'eslint-config-prettier'
+// eslint-disable-next-line import/namespace, import/no-named-as-default, import/no-named-as-default-member
+import eslintPluginPrettier from 'eslint-plugin-prettier'
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+const prettierConfig = [
+  // should be placed at the end to override other configs
+  {
+    plugins: {
+      prettier: eslintPluginPrettier,
+    },
+    rules: {
+      ...eslintConfigPrettier.rules,
+      ...eslintPluginPrettier.configs['recommended']?.rules,
+    },
+  },
+]
+export default prettierConfig

package/bases/react.mjs

@@ -0,0 +1,92 @@
+import eslintPluginReact from 'eslint-plugin-react'
+import eslintPluginReactHooks from 'eslint-plugin-react-hooks'
+import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
+
+import { testFileGlobs } from '../constants.mjs'
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+const reactConfig = [
+  {
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+        // copied from `eslintPluginReact.configs['jsx-runtime']`
+        jsxPragma: null, // for @typescript-eslint/parser
+      },
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+    plugins: {
+      react: eslintPluginReact,
+      'react-hooks': eslintPluginReactHooks,
+    },
+    rules: {
+      ...eslintPluginReact.configs['recommended']?.rules,
+      ...eslintPluginReact.configs['jsx-runtime']?.rules,
+      ...eslintPluginReactHooks.configs['recommended']?.rules,
+      // avoid unexpected form submits
+      'react/button-has-type': 'error',
+      'react/jsx-no-useless-fragment': [
+        'error',
+        {
+          // allow unnecessary fragment for single expression to bypass some typescript errors (e.g. do not allow string and only allow react element)
+          allowExpressions: true,
+        },
+      ],
+      'react/jsx-sort-props': [
+        'error',
+        {
+          // any prop starts with `on`
+          callbacksLast: true,
+          ignoreCase: true,
+          noSortAlphabetically: false,
+          reservedFirst: true,
+          shorthandFirst: false,
+          shorthandLast: false,
+        },
+      ],
+      // rely on typescript instead, and it does not work well with types that are imported from elsewhere
+      'react/prop-types': 'off',
+      // avoid unnecessary closing tags
+      'react/self-closing-comp': 'error',
+      'react-hooks/exhaustive-deps': [
+        'error',
+        {
+          // support package `use-deep-compare`
+          additionalHooks:
+            '(useDeepCompareCallback|useDeepCompareEffect|useDeepCompareMemo)',
+        },
+      ],
+    },
+  },
+  {
+    files: testFileGlobs,
+    plugins: {
+      'testing-library': eslintPluginTestingLibrary,
+    },
+    rules: {
+      ...eslintPluginTestingLibrary.configs['react']?.rules,
+      // avoid using unnecessary `await` as workaround for `not wrapped in act(...)` warnings
+      'testing-library/no-await-sync-events': [
+        'error',
+        {
+          eventModules: ['fire-event'],
+        },
+      ],
+      // global flag /g holds state and might cause false-positives while querying for elements
+      'testing-library/no-global-regexp-flag-in-query': 'error',
+      // explicitly assert the element to prevent reader missed the test cases
+      'testing-library/prefer-explicit-assert': 'error',
+      // prefer @testing-library/user-event over fireEvent
+      'testing-library/prefer-user-event': 'error',
+      // as `wait` is deprecated
+      'testing-library/prefer-wait-for': 'error',
+    },
+  },
+]
+export default reactConfig

package/constants.mjs

@@ -0,0 +1,15 @@
+export const supportedFilesGlob = '**/*.{cjs,cts,js,mjs,mts,ts,tsx}'
+export const testFileGlobs = [
+  '**/__fixtures__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
+  '**/__mocks__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
+  '**/__tests__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
+  '**/*.{spec,test}.{cjs,cts,js,mjs,mts,ts,tsx}',
+]
+
+export const typeScriptFileGlobs = ['**/*.{cts,mts,ts,tsx}']
+export const typeScriptTestFileGlobs = [
+  '**/__fixtures__/**/*.{cts,mts,ts,tsx}',
+  '**/__mocks__/**/*.{cts,mts,ts,tsx}',
+  '**/__tests__/**/*.{cts,mts,ts,tsx}',
+  '**/*.{spec,test}.{cts,mts,ts,tsx}',
+]

package/index.mjs

@@ -0,0 +1,31 @@
+import baseConfig from './bases/base.mjs'
+import browserConfig from './bases/browser.mjs'
+import nodeConfig from './bases/node.mjs'
+import prettierConfig from './bases/prettier.mjs'
+import reactConfig from './bases/react.mjs'
+
+export * from './utils/applyConfig.mjs'
+
+/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+export const eslintBrowserConfig = [
+  ...baseConfig,
+  ...browserConfig,
+  ...prettierConfig,
+]
+
+/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+export const eslintNodeConfig = [
+  ...baseConfig,
+  ...nodeConfig,
+  ...prettierConfig,
+]
+
+/** @type {readonly import('eslint').Linter.FlatConfig[]} */
+export const eslintReactConfig = [
+  ...baseConfig,
+  ...browserConfig,
+  ...reactConfig,
+  ...prettierConfig,
+]
+
+export { default as eslintIgnoresConfig } from './bases/ignores.mjs'

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "9.2.0",
+  "version": "10.0.1",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -10,54 +10,53 @@
     "directory": "packages/eslint-config"
   },
   "license": "MIT",
-  "exports": {
-    ".": "./index.cjs",
-    "./react": "./react.cjs"
-  },
+  "type": "module",
+  "exports": "./index.mjs",
   "files": [
     "**/*.{cjs,js,json,mjs}",
-    "*.md",
-    "eslintignore"
+    "*.md"
   ],
   "scripts": {
     "type:check": "tsc"
   },
   "dependencies": {
-    "@foray1010/common-presets-utils": "^6.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@eslint-community/eslint-plugin-eslint-comments": "^3.2.1",
+    "@eslint/js": "^8.36.0",
+    "@foray1010/common-presets-utils": "^7.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
     "confusing-browser-globals": "^1.0.10",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "^3.5.2",
-    "eslint-plugin-compat": "^4.0.0",
+    "eslint-plugin-compat": "^4.1.2",
     "eslint-plugin-deprecation": "^1.3.2",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-functional": "^4.4.1",
+    "eslint-plugin-functional": "^5.0.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^27.1.3",
     "eslint-plugin-jest-dom": "^4.0.0",
-    "eslint-plugin-jsdoc": "^40.0.0",
+    "eslint-plugin-jsdoc": "^40.1.0",
     "eslint-plugin-n": "^15.3.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.31.10",
+    "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.9.1",
-    "eslint-plugin-unicorn": "^45.0.0"
+    "eslint-plugin-testing-library": "^5.10.2",
+    "eslint-plugin-unicorn": "^46.0.0",
+    "globals": "^13.19.0"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "1.0.0",
-    "@types/eslint": "8.21.1"
+    "@types/eslint": "8.21.3"
   },
   "peerDependencies": {
-    "eslint": "^8.0.0",
+    "eslint": "^8.36.0",
     "prettier": "^2.0.0"
   },
   "engines": {
-    "node": "^14.18.0 || ^16.13.0 || >=18.12.0"
+    "node": "^16.14.0 || >=18.12.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "11a76b57489f7de8f08ec5cd47f8747c4c432f09"
+  "gitHead": "c722884bc466360097d9ab80e72f350a15ed7cad"
 }

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "@foray1010/tsconfig",
+  "extends": "@foray1010/tsconfig/tsconfig.base.json",
   "compilerOptions": {
     "allowJs": true,
     "checkJs": true

package/utils/applyConfig.mjs

@@ -0,0 +1,62 @@
+import path from 'node:path'
+
+import { supportedFilesGlob } from '../constants.mjs'
+
+/**
+ * Extend the flat configs with default files and ignores
+ * @param {{
+ *   readonly filePrefixes: string | string[],
+ *   readonly ignores?: string | string[] | undefined
+ * }} options
+ * @param {readonly import('eslint').Linter.FlatConfig[]} flatConfigs
+ * @returns {readonly import('eslint').Linter.FlatConfig[]}
+ */
+export function applyConfig(options, flatConfigs) {
+  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) {
+    if (typeof config === 'string') {
+      throw new TypeError(
+        `Cannot extend ${config} with files/ignores, use \`@eslint/js\` instead`,
+      )
+    }
+
+    if (Object.keys(config).includes('ignores')) {
+      throw new TypeError('Do not use `ignores` in config')
+    }
+  }
+
+  return flatConfigs.map((config) => {
+    const files = generateCombinations(filePrefixes, config.files)
+    return {
+      ...config,
+      ...(files ? { files } : {}),
+      ...(options.ignores ? { ignores: options.ignores } : {}),
+    }
+  })
+}
+
+/**
+ * @param {string[]} prefixes
+ * @param {string | string[] | undefined} originalGlobs
+ * @returns {string | string[] | undefined}
+ */
+function generateCombinations(prefixes, originalGlobs) {
+  if (!originalGlobs || originalGlobs.length === 0) {
+    return prefixes.map((prefix) => path.join(prefix, supportedFilesGlob))
+  }
+
+  const originalGlobList = [originalGlobs].flat()
+
+  return prefixes.flatMap((prefix) => {
+    return originalGlobList.flatMap((originalGlob) => {
+      const signRegexp = /^!/
+      const sign = originalGlob.match(signRegexp)?.[0] ?? ''
+      return sign + path.join(prefix, originalGlob.replace(signRegexp, ''))
+    })
+  })
+}

package/eslintignore

@@ -1,6 +0,0 @@
-!.*
-.yarn/
-build/
-coverage/
-dist/
-node_modules/

package/index.cjs

@@ -1,6 +0,0 @@
-'use strict'
-
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-  extends: ['./presets/base.cjs', './presets/node.cjs'],
-}