@will-stone/eslint-config 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @will-stone/eslint-config
+
+## 0.0.1
+
+### Patch Changes
+
+- 40e33d5: Initial release.

package/eslint-config.js

@@ -0,0 +1,151 @@
+import fs from 'node:fs'
+
+import importPlugin from 'eslint-plugin-import'
+import jestPlugin from 'eslint-plugin-jest'
+import jsxA11yPlugin from 'eslint-plugin-jsx-a11y'
+import nPlugin from 'eslint-plugin-n'
+import prettierPlugin from 'eslint-plugin-prettier'
+import reactPlugin from 'eslint-plugin-react'
+import reactHooksPlugin from 'eslint-plugin-react-hooks'
+import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort'
+import switchCasePlugin from 'eslint-plugin-switch-case'
+import unicornPlugin from 'eslint-plugin-unicorn'
+import globals from 'globals'
+import { globbySync } from 'globby'
+import { loadJsonFileSync } from 'load-json-file'
+
+import builtInRules from './rules/built-in.js'
+import importRules from './rules/import.js'
+import jestRules from './rules/jest.js'
+import jestTsRules from './rules/jest-ts.js'
+import jsxA11yRules from './rules/jsx-a11y.js'
+import nodeRules from './rules/node.js'
+import prettierRules from './rules/prettier.js'
+import reactRules from './rules/react.js'
+import switchCaseRules from './rules/switch-case.js'
+import tsRules from './rules/typescript.js'
+import unicornRules from './rules/unicorn.js'
+
+let testingFramework = null
+let isNodeEngine = false
+let isPrettier = false
+
+// In a monorepo environment with one eslint instance at the root of the project,
+// we must traverse every child package.json to find out if certain dependencies
+// are included, so that we know which plugins and rules to include.
+const allPackageJsonPaths = globbySync([
+  '**/package.json',
+  // Could use the `gitIgnore` option but the negative pattern is about 8 times faster.
+  // https://github.com/sindresorhus/globby/issues/50
+  '!**/node_modules',
+])
+
+for (const packageJsonPath of allPackageJsonPaths) {
+  const packageJson = loadJsonFileSync(packageJsonPath)
+
+  if (
+    !testingFramework &&
+    Boolean(packageJson.dependencies?.jest || packageJson.devDependencies?.jest)
+  ) {
+    testingFramework = 'jest'
+  }
+
+  if (!isNodeEngine && Boolean(packageJson.engines?.node)) {
+    isNodeEngine = true
+  }
+
+  if (
+    !isPrettier &&
+    Boolean(
+      packageJson.dependencies?.prettier ||
+        packageJson.devDependencies?.prettier,
+    )
+  ) {
+    isPrettier = true
+  }
+}
+
+const isNode =
+  isNodeEngine || fs.existsSync('.nvmrc') || fs.existsSync('.node-version')
+
+export default [
+  // Global
+  {
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+
+  // Base
+  {
+    files: ['**/*.{js,cjs,mjs,jsx,ts,tsx}'],
+    languageOptions: {
+      globals: isNode && globals.node,
+    },
+    plugins: {
+      'import': importPlugin,
+      'simple-import-sort': simpleImportSortPlugin,
+      'switch-case': switchCasePlugin,
+      'unicorn': unicornPlugin,
+      ...(isNode && { n: nPlugin }),
+      ...(isPrettier && { prettier: prettierPlugin }),
+    },
+    rules: {
+      ...builtInRules,
+      ...importRules,
+      ...switchCaseRules,
+      ...unicornRules,
+      ...(isNode && nodeRules),
+      ...(isPrettier && prettierRules),
+    },
+  },
+
+  // TS
+  {
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      parser: '@typescript-eslint/parser',
+    },
+    rules: tsRules,
+  },
+
+  // JSX files (React)
+  {
+    files: ['**/*.{jsx,tsx}'],
+    languageOptions: {
+      globals: globals.browser,
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    plugins: {
+      'jsx-a11y': jsxA11yPlugin,
+      'react': reactPlugin,
+      'react-hooks': reactHooksPlugin,
+    },
+    rules: {
+      ...jsxA11yRules,
+      ...reactRules,
+    },
+  },
+
+  // Jest
+  {
+    files: ['**/*.{spec,test}.{js,cjs,mjs,jsx,ts,tsx}'],
+    languageOptions: {
+      globals: testingFramework === 'jest' && globals.jest,
+    },
+    plugins: testingFramework === 'jest' && {
+      jest: jestPlugin,
+    },
+    rules: testingFramework === 'jest' && jestRules,
+  },
+  {
+    files: ['**/*.{spec,test}.{ts,tsx}'],
+    rules: testingFramework === 'jest' && jestTsRules,
+  },
+]

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@will-stone/eslint-config",
+  "version": "0.0.1",
+  "description": "Will Stone's ESLint config, using the Flat Config style.",
+  "keywords": [
+    "ESLint"
+  ],
+  "homepage": "https://github.com/will-stone/dx#readme",
+  "bugs": {
+    "url": "https://github.com/will-stone/dx/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/will-stone/dx.git"
+  },
+  "license": "MIT",
+  "author": "Will Stone",
+  "type": "module",
+  "main": "eslint-config.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
+    "confusing-browser-globals": "^1.0.11",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.4.0",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-n": "^16.1.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-switch-case": "^1.1.2",
+    "eslint-plugin-unicorn": "^48.0.1",
+    "globals": "^13.21.0",
+    "globby": "^13.2.2",
+    "load-json-file": "^7.0.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}