@foray1010/eslint-config 9.2.0 → 10.0.0

package/bases/node.mjs

@@ -0,0 +1,75 @@
+// @ts-expect-error
+import { isESM } from '@foray1010/common-presets-utils'
+import eslintPluginN from 'eslint-plugin-n'
+
+/** @type {import('eslint').Linter.FlatConfig} */
+const cjsConfig = {
+  languageOptions: {
+    globals: {
+      // @ts-expect-error
+      __dirname: 'readonly',
+      // @ts-expect-error
+      __filename: 'readonly',
+    },
+  },
+}
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+const nodeConfig = [
+  {
+    plugins: {
+      n: eslintPluginN,
+    },
+    languageOptions: {
+      globals: {
+        // hack to mute no-undef error, and show n/prefer-global/buffer error instead
+        // @ts-expect-error
+        Buffer: 'writable',
+        // hack to mute no-undef error, and show n/prefer-global/process error instead
+        // @ts-expect-error
+        process: 'writable',
+      },
+    },
+    rules: {
+      // disallow deprecated node APIs
+      'n/no-deprecated-api': 'error',
+      // disallow the assignment to `exports`
+      'n/no-exports-assign': 'error',
+      // disallow `bin` files that npm ignores
+      'n/no-unpublished-bin': 'error',
+      // disallow unsupported Node.js built-in APIs on the specified version
+      'n/no-unsupported-features/node-builtins': 'error',
+      // prefer `import { Buffer } from 'node:buffer'` as it is not isomorphic
+      'n/prefer-global/buffer': ['error', 'never'],
+      // prefer global `console` to be isomorphic
+      'n/prefer-global/console': ['error', 'always'],
+      // prefer `import process from 'node:process'` as it is not isomorphic
+      'n/prefer-global/process': ['error', 'never'],
+      // prefer global `TextDecoder` to be isomorphic
+      'n/prefer-global/text-decoder': ['error', 'always'],
+      // prefer global `TextEncoder` to be isomorphic
+      'n/prefer-global/text-encoder': ['error', 'always'],
+      // prefer global `URL` to be isomorphic
+      'n/prefer-global/url': ['error', 'always'],
+      // prefer global `URLSearchParams` to be isomorphic
+      'n/prefer-global/url-search-params': ['error', 'always'],
+      // make `process.exit()` expressions the same code path as `throw`
+      'n/process-exit-as-throw': 'error',
+      // enforce shebang on the entry bin file
+      'n/shebang': 'error',
+    },
+  },
+  ...(isESM()
+    ? []
+    : [
+        {
+          files: ['**/*.js'],
+          ...cjsConfig,
+        },
+      ]),
+  {
+    files: ['**/*.{cjs,cts}'],
+    ...cjsConfig,
+  },
+]
+export default nodeConfig

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/{presets/utils/testUtil.cjs → constants.mjs}

@@ -1,9 +1,8 @@
-'use strict'
-
-const testFileGlobs = [
+export const testFileGlobs = [
   '**/__fixtures__/**',
   '**/__mocks__/**',
   '**/__tests__/**',
   '**/*.{spec,test}.{cjs,cts,js,mjs,mts,ts,tsx}',
 ]
-exports.testFileGlobs = testFileGlobs
+
+export const typeScriptFileGlobs = ['**/*.{cts,mts,ts,tsx}']

package/index.mjs

@@ -0,0 +1,32 @@
+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 eslintFilesConfig } from './bases/files.mjs'
+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.0",
   "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": "ee22f073ee1702354310091b7c3a5ec18a930bec"
 }

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,61 @@
+import path from 'node:path'
+
+/**
+ * Extend the flat configs with default files and ignores
+ * @param {{
+ *   readonly filePrefixes?: string[] | undefined,
+ *   readonly ignorePrefixes?: string[] | undefined
+ * }} options
+ * @param {readonly import('eslint').Linter.FlatConfig[]} flatConfigs
+ * @returns {readonly import('eslint').Linter.FlatConfig[]}
+ */
+export function applyConfig(options, flatConfigs) {
+  // 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`,
+      )
+    }
+
+    const keys = Object.keys(config)
+    if (
+      keys.length === 1 &&
+      (keys.includes('files') || keys.includes('ignores'))
+    ) {
+      throw new TypeError('Do not use `files` or `ignores` only')
+    }
+  }
+
+  return flatConfigs.map((config) => {
+    const files = generateCombinations(options.filePrefixes, config.files)
+    const ignores = generateCombinations(options.ignorePrefixes, config.ignores)
+    return {
+      ...config,
+      ...(files ? { files } : {}),
+      ...(ignores ? { ignores } : {}),
+    }
+  })
+}
+
+/**
+ * @param {string[] | undefined} prefixes
+ * @param {string | string[] | undefined} originalGlobs
+ * @returns {string | string[] | undefined}
+ */
+function generateCombinations(prefixes, originalGlobs) {
+  if (!prefixes || prefixes.length === 0) return originalGlobs
+  if (!originalGlobs || originalGlobs.length === 0) {
+    return prefixes.map((prefix) => path.join(prefix, '**'))
+  }
+
+  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'],
-}