@stzhu/eslint-config 0.1.0

package/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize]
+jobs:
+  checks:
+    name: Checks
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - run: pnpm install
+      - run: pnpm run lint

package/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+on:
+  release:
+    types: [published]
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          cache: pnpm
+          registry-url: https://registry.npmjs.org
+      - run: pnpm install
+      - run: pnpm run lint
+      - run: pnpm publish --provenance --access public --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

package/.prettierrc.yaml

@@ -0,0 +1,5 @@
+plugins:
+  - prettier-plugin-packagejson
+  - '@stzhu/prettier-plugin-tsconfig'
+singleQuote: true
+trailingComma: all

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Steve Zhu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @stzhu/eslint-config
+
+## Usage
+
+Install:
+
+```
+pnpm i -D @stzhu/eslint-config
+```
+
+Create a `eslint.config.js` with the following config:
+
+```javascript
+// @ts-check
+
+import { defineConfig } from '@internal/eslint-config';
+import tsConfig from '@internal/eslint-config/ts';
+
+export default defineConfig(
+  // select from one of the configs below
+  ...tsConfig,
+);
+```
+
+### Shareable Configs
+
+Import one of the following required main configs depending on the project type.
+
+- `@internal/eslint-config/ts`: Typescript Project
+- `@internal/eslint-config/react`: React Project
+
+Import any of the following optional configs depending on usage.
+
+- `@internal/eslint-config/vitest`
+- `@internal/eslint-config/storybook`

package/eslint.config.js

@@ -0,0 +1,13 @@
+// @ts-check
+
+import js from '@eslint/js';
+import prettier from 'eslint-config-prettier';
+import tseslint from 'typescript-eslint';
+
+import importConfig from './src/configs/import.js';
+
+export default tseslint.config(
+  js.configs.recommended,
+  ...importConfig,
+  prettier,
+);

package/jsconfig.json

@@ -0,0 +1,12 @@
+{
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "noEmit": true,
+    "allowJs": true,
+    "checkJs": true,
+    "maxNodeModuleJsDepth": 0
+  }
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@stzhu/eslint-config",
+  "version": "0.1.0",
+  "description": "Shared config for ESLint",
+  "keywords": [
+    "eslint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stevezhu/eslint-config.git"
+  },
+  "license": "MIT",
+  "author": "Steve Zhu <4130171+stevezhu@users.noreply.github.com>",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js",
+    "./ts": "./src/ts.js",
+    "./react": "./src/react.js",
+    "./node": "./src/node.js",
+    "./expo": "./src/expo.js",
+    "./storybook": "./src/storybook.js",
+    "./vitest": "./src/vitest.js",
+    "./tailwind": "./src/tailwind.js",
+    "./lingui": "./src/lingui.js"
+  },
+  "bin": {
+    "eslint": "./node_modules/eslint/bin/eslint.js"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.28.0",
+    "@typescript-eslint/eslint-plugin": "^8.33.1",
+    "@typescript-eslint/parser": "^8.33.1",
+    "@vitest/eslint-plugin": "^1.2.1",
+    "eslint": "^9.28.0",
+    "eslint-config-expo": "^9.2.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-config-turbo": "^2.5.4",
+    "eslint-plugin-expo": "^0.1.4",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-lingui": "^0.10.1",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-storybook": "^0.12.0",
+    "eslint-plugin-tailwindcss": "^3.18.0",
+    "eslint-plugin-turbo": "^2.5.4",
+    "globals": "^16.2.0",
+    "postcss": "^8.5.4",
+    "tailwindcss": "^4.1.8",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.33.1"
+  },
+  "devDependencies": {
+    "@stzhu/prettier-plugin-tsconfig": "^0.5.0",
+    "@stzhu/tsconfig": "^0.1.0",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "eslint-plugin-import-x": "^4.15.1",
+    "prettier": "^3.5.3",
+    "prettier-plugin-packagejson": "^2.5.15"
+  },
+  "peerDependencies": {
+    "postcss": "^8",
+    "tailwindcss": "^4",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "format": "prettier -w .",
+    "lint": "prettier -c . && eslint .",
+    "test": "tsc --noEmit -p jsconfig.json"
+  }
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+onlyBuiltDependencies:
+  - unrs-resolver

package/src/configs/import.js

@@ -0,0 +1,27 @@
+import importX from 'eslint-plugin-import-x';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    name: 'import/custom',
+    plugins: {
+      'import-x': importX,
+    },
+    rules: {
+      'import-x/first': 'error',
+      'import-x/newline-after-import': 'error',
+      'import-x/no-duplicates': 'error',
+    },
+  },
+  {
+    name: 'simple-import-sort/custom',
+    plugins: {
+      'simple-import-sort': simpleImportSort,
+    },
+    rules: {
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+    },
+  },
+);

package/src/configs/typescript.js

@@ -0,0 +1,61 @@
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  ...tseslint.configs.strictTypeChecked,
+  {
+    name: 'typescript/languageOptions',
+    languageOptions: {
+      parserOptions: {
+        project: true,
+      },
+    },
+  },
+  {
+    name: 'typescript/custom',
+    rules: {
+      '@typescript-eslint/consistent-type-definitions': 'off',
+      '@typescript-eslint/no-misused-promises': [
+        'error',
+        {
+          checksVoidReturn: {
+            attributes: false,
+          },
+        },
+      ],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+        },
+      ],
+      '@typescript-eslint/restrict-template-expressions': [
+        'error',
+        {
+          allowNumber: true,
+        },
+      ],
+      // https://tanstack.com/router/v1/docs/framework/react/api/router/redirectFunction
+      '@typescript-eslint/only-throw-error': [
+        'warn',
+        {
+          allow: [
+            {
+              from: 'package',
+              name: 'Redirect',
+              package: '@tanstack/router-core',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    files: ['**/*.{cjs,js}'],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+);

package/src/expo.js

@@ -0,0 +1,7 @@
+import expo from 'eslint-config-expo/flat.js';
+import prettier from 'eslint-config-prettier';
+import tseslint from 'typescript-eslint';
+
+import importConfig from './configs/import.js';
+
+export default tseslint.config(...expo, ...importConfig, prettier);

package/src/index.js

@@ -0,0 +1,3 @@
+import { config } from 'typescript-eslint';
+
+export const defineConfig = config;

package/src/lingui.js

@@ -0,0 +1,4 @@
+import pluginLingui from 'eslint-plugin-lingui';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(pluginLingui.configs['flat/recommended']);

package/src/node.js

@@ -0,0 +1,10 @@
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+import baseConfig from './ts.js';
+
+export default tseslint.config(...baseConfig, {
+  languageOptions: {
+    globals: globals.node,
+  },
+});

package/src/react.js

@@ -0,0 +1,46 @@
+import prettier from 'eslint-config-prettier';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+import baseConfig from './ts.js';
+
+export default tseslint.config(
+  ...baseConfig,
+  {
+    name: 'react/src-browser-globals',
+    files: ['src/**/*.{ts,tsx}'],
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
+  react.configs.flat['recommended'],
+  react.configs.flat['jsx-runtime'],
+  {
+    name: 'react/custom',
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+    rules: {
+      'react/function-component-definition': [
+        'error',
+        { namedComponents: 'function-declaration' },
+      ],
+    },
+  },
+  reactHooks.configs['recommended-latest'],
+  {
+    name: 'react-refresh/custom',
+    plugins: {
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      'react-refresh/only-export-components': 'warn',
+    },
+  },
+  prettier,
+);

package/src/storybook.js

@@ -0,0 +1,4 @@
+import storybook from 'eslint-plugin-storybook';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(...storybook.configs['flat/recommended']);

package/src/tailwind.js

@@ -0,0 +1,4 @@
+import tailwind from 'eslint-plugin-tailwindcss';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(...tailwind.configs['flat/recommended']);

package/src/ts.js

@@ -0,0 +1,28 @@
+import js from '@eslint/js';
+import prettier from 'eslint-config-prettier';
+import turbo from 'eslint-plugin-turbo';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+import importConfig from './configs/import.js';
+import typescriptConfig from './configs/typescript.js';
+
+export default tseslint.config(
+  {
+    // TODO: can't name this because ignores needs to be the only entry in order to be global
+    // name: 'ts/ignores',
+    ignores: ['dist/', '.wrangler/'],
+  },
+  turbo.configs['flat/recommended'],
+  Object.assign({ name: '@eslint/js/recommended' }, js.configs.recommended),
+  ...importConfig,
+  {
+    name: 'ts/config-file-globals',
+    files: ['*.config.{cjs,js,ts}'],
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+  ...typescriptConfig,
+  prettier,
+);

package/src/vitest.js

@@ -0,0 +1,31 @@
+import vitest from '@vitest/eslint-plugin';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  Object.assign({ name: 'vitest/recommended' }, vitest.configs.recommended),
+  {
+    name: 'custom/vitest',
+    files: ['**/*.test.{ts,tsx}'],
+    rules: {
+      'vitest/consistent-test-it': [
+        'error',
+        {
+          fn: 'test',
+          withinDescribe: 'test',
+        },
+      ],
+      'vitest/no-focused-tests': 'error',
+      'vitest/no-disabled-tests': 'error',
+      'vitest/prefer-lowercase-title': [
+        'warn',
+        {
+          ignoreTopLevelDescribe: true,
+        },
+      ],
+      'vitest/valid-expect': 'off',
+      // Disable certain strict typescript eslint rules for tests
+      // https://github.com/vitest-dev/vitest/issues/4543#issuecomment-1824881253
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+    },
+  },
+);