@evanpurkhiser/oxc-config 0.2.0

package/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: ci
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: npm ci
+      - run: npm run check

package/.github/workflows/main.yml

@@ -0,0 +1,37 @@
+name: publish
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: npm ci
+      - run: npm run check
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: check
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - name: bump version
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "<>"
+          npm version minor
+          git push
+      - run: npm publish --provenance --access=public

package/README.md

@@ -0,0 +1,49 @@
+## Evan Purkhiser's Personal Oxc config
+
+[![publish](https://github.com/evanpurkhiser/oxc-config/workflows/publish/badge.svg)](https://github.com/evanpurkhiser/oxc-config/actions?query=workflow%3Apublish)
+[![NPM](https://img.shields.io/npm/v/@evanpurkhiser/oxc-config)](https://www.npmjs.com/package/@evanpurkhiser/oxc-config)
+
+These are my Oxc linting and formatting configurations that I use across my
+various personal
+projects.
+
+```bash
+npm install -D oxlint oxfmt @evanpurkhiser/oxc-config
+```
+
+Create an `oxlint.config.ts` file with the contents:
+
+```ts
+import {defineConfig} from 'oxlint';
+import {all} from '@evanpurkhiser/oxc-config';
+
+export default defineConfig({
+  extends: all,
+});
+```
+
+The default configuration is for React apps, but you can select from the
+following configurations:
+
+- `common` - ES6 and Typescript rules
+- `react` - React specific rules
+
+For example:
+
+```ts
+import {defineConfig} from 'oxlint';
+import {common} from '@evanpurkhiser/oxc-config';
+
+export default defineConfig({
+  extends: [common],
+});
+```
+
+For Oxfmt, create an `oxfmt.config.ts` file:
+
+```ts
+import {defineConfig} from 'oxfmt';
+import {oxfmt} from '@evanpurkhiser/oxc-config/oxfmt';
+
+export default defineConfig(oxfmt);
+```

package/REPO_ANALYSIS.md

@@ -0,0 +1,45 @@
+# ESLint to Oxlint migration analysis
+
+## Scope reviewed
+
+- `/home/evan/coding/recovery`
+- `/home/evan/coding/instagram-saver`
+- `/home/evan/coding/meal-log`
+- `/home/evan/coding/atuin-abacus`
+- `/home/evan/coding/prolink-connect`
+- `/home/evan/coding/waitress`
+- `/home/evan/coding/transmission-helper`
+- `/home/evan/coding/email-to-lunchmoney`
+- `/home/evan/coding/tooling-personal`
+- `/home/evan/coding/rekordbox-parser`
+- `/home/evan/coding/tune-manager`
+- `/home/evan/coding/doppovich-bot`
+- `/home/evan/coding/keyway-twilio`
+- `/home/evan/coding/prolink-tools`
+
+## Findings by repository
+
+| Repository            | Current ESLint setup                                                                                                     | Recommended Oxlint preset | Special handling                                                                     |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------- | ------------------------------------------------------------------------------------ |
+| `recovery`            | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | No custom lint rules needed.                                                         |
+| `instagram-saver`     | Flat config: `all` + `prettier/prettier: off`                                                                            | `all`                     | No custom lint rules needed.                                                         |
+| `meal-log`            | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | No custom lint rules needed.                                                         |
+| `atuin-abacus`        | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | Deno repo; validate JS/TS file globs for CLI usage.                                  |
+| `prolink-connect`     | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | Keep test-specific overrides local if needed later.                                  |
+| `waitress`            | Flat config: `all` + `prettier/prettier: off`                                                                            | `all`                     | Browser React app.                                                                   |
+| `transmission-helper` | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | No custom lint rules needed.                                                         |
+| `email-to-lunchmoney` | Flat config: `common` + `prettier/prettier: off`                                                                         | `common`                  | Cloudflare Worker; add env/global overrides only if diagnostics require it.          |
+| `tooling-personal`    | Flat config: `all` + `prettier/prettier: off`                                                                            | `all`                     | Tooling repo likely to become migration templates.                                   |
+| `rekordbox-parser`    | Legacy `.eslintrc.js`: extends `common`, node env, prettier off                                                          | `common`                  | Add `env.node: true` in local config.                                                |
+| `tune-manager`        | Legacy `.eslintrc.js`: extends default (`all`), browser env, prettier off                                                | `all`                     | Add `env.browser: true` explicitly if needed.                                        |
+| `doppovich-bot`       | Legacy `.eslintrc.js`: extends `common`, node env, prettier off                                                          | `common`                  | Add `env.node: true` in local config.                                                |
+| `keyway-twilio`       | Legacy `.eslintrc.js`: extends `common`, node env, prettier off                                                          | `common`                  | Add `env.node: true` in local config.                                                |
+| `prolink-tools`       | Legacy `.eslintrc.js`: extends default (`all`) with custom import groups and `typescript/no-unused-vars` ignore patterns | `all`                     | Keep repo-local overrides for import sorting groups and unused-vars ignore patterns. |
+
+## Cross-repo migration notes
+
+1. Every repo disables `prettier/prettier`; this is naturally removed in Oxlint.
+2. Most repos can use only one line of config via `extends: [common]` or `extends: all`.
+3. Legacy repos that currently set `env.node` should keep that as repo-local override.
+4. `prolink-tools` should keep local customizations because the internal import groups differ from the shared default.
+5. Run dual lint (`oxlint` + `eslint`) temporarily only for repos where any unsupported rule must be retained.

package/oxfmt.config.ts

@@ -0,0 +1,5 @@
+import {defineConfig} from 'oxfmt';
+
+import {oxfmt} from './src/oxfmt.mjs';
+
+export default defineConfig(oxfmt);

package/oxlint.config.ts

@@ -0,0 +1,7 @@
+import {defineConfig} from 'oxlint';
+
+import {common} from './src/index.mjs';
+
+export default defineConfig({
+  extends: [common],
+});

package/package.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@evanpurkhiser/oxc-config",
+  "version": "0.2.0",
+  "description": "Evan Purkhiser's personal Oxc configuration",
+  "license": "MIT",
+  "author": "Evan Purkhiser",
+  "repository": "https://github.com/evanpurkhiser/oxc-config",
+  "type": "module",
+  "main": "src/index.mjs",
+  "exports": {
+    ".": "./src/index.mjs",
+    "./common": "./src/common.mjs",
+    "./react": "./src/react.mjs",
+    "./oxfmt": "./src/oxfmt.mjs"
+  },
+  "scripts": {
+    "lint": "oxlint src oxlint.config.ts profiles/all/oxlint.config.ts",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
+    "check": "npm run lint && npm run format:check"
+  },
+  "dependencies": {
+    "eslint-plugin-simple-import-sort": "^12.1.1"
+  },
+  "devDependencies": {
+    "oxfmt": "^0.41.0",
+    "oxlint": "^1.56.0",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "oxlint": ">=1.56.0"
+  },
+  "volta": {
+    "node": "24.3.0"
+  }
+}

package/profiles/all/oxlint.config.ts

@@ -0,0 +1,7 @@
+import {defineConfig} from 'oxlint';
+
+import {all} from '../../src/index.mjs';
+
+export default defineConfig({
+  extends: all,
+});

package/src/common.mjs

@@ -0,0 +1,81 @@
+import {builtinModules} from 'node:module';
+
+const common = {
+  plugins: ['eslint', 'typescript', 'unicorn', 'oxc', 'import', 'react'],
+
+  jsPlugins: ['eslint-plugin-simple-import-sort'],
+
+  rules: {
+    // Best practices
+    'array-callback-return': ['warn'],
+    'consistent-return': ['warn'],
+    'no-caller': ['warn'],
+    'no-else-return': ['error', {allowElseIf: false}],
+    'no-extra-label': ['error'],
+    'no-floating-decimal': ['error'],
+    'no-implied-eval': ['error'],
+    'no-lone-blocks': ['error'],
+    'no-return-await': ['error'],
+    'no-self-compare': ['error'],
+    'no-sequences': ['error'],
+    'no-useless-call': ['warn'],
+    'no-useless-concat': ['warn'],
+    'no-useless-return': ['warn'],
+    'require-await': ['warn'],
+    curly: ['error'],
+    eqeqeq: ['error'],
+    radix: ['warn'],
+
+    // Variables
+    'no-undef-init': ['warn'],
+
+    // Style (mostly handled by prettier/oxfmt)
+    'eol-last': ['error', 'always'],
+    'new-parens': ['error'],
+    'padded-blocks': ['warn', 'never'],
+    'spaced-comment': ['warn', 'always'],
+
+    // ECMAScript
+    'no-var': ['error'],
+    'prefer-arrow-callback': ['warn'],
+    'prefer-const': ['error'],
+    'prefer-destructuring': ['off'],
+    'prefer-numeric-literals': ['warn'],
+    'prefer-rest-params': ['warn'],
+    'prefer-spread': ['warn'],
+    'prefer-template': ['warn'],
+    'arrow-body-style': ['error', 'as-needed'],
+
+    // Disabled for TypeScript
+    'no-unused-expressions': ['off'],
+
+    // TypeScript
+    'typescript/explicit-function-return-type': ['off'],
+    'typescript/no-use-before-define': ['off'],
+    'typescript/no-explicit-any': ['off'],
+    'typescript/no-non-null-assertion': ['off'],
+    'typescript/explicit-module-boundary-types': ['off'],
+    'typescript/no-unused-vars': ['error', {argsIgnorePattern: '^_'}],
+    'typescript/no-unused-expressions': ['error'],
+    'typescript/no-useless-constructor': ['error'],
+    'typescript/array-type': ['error', {default: 'array-simple'}],
+
+    // Sort imports
+    'simple-import-sort/exports': 'error',
+    'simple-import-sort/imports': [
+      'error',
+      {
+        groups: [
+          ['^\\u0000'],
+          ['^react', '^@?\\w'],
+          [`^(${builtinModules.join('|')})(/|$)`],
+          ['^(src|app)(/.*|$)'],
+          ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
+          ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
+        ],
+      },
+    ],
+  },
+};
+
+export {common};

package/src/index.mjs

@@ -0,0 +1,6 @@
+import {common} from './common.mjs';
+import {react} from './react.mjs';
+
+const all = [common, react];
+
+export {all, common, react};

package/src/oxfmt.mjs

@@ -0,0 +1,33 @@
+const oxfmt = {
+  bracketSpacing: false,
+  printWidth: 90,
+  singleQuote: true,
+  arrowParens: 'avoid',
+  sortImports: {
+    sortSideEffects: true,
+    customGroups: [
+      {
+        groupName: 'react-libs',
+        selector: 'external',
+        elementNamePattern: ['react', 'react-**'],
+      },
+      {
+        groupName: 'project-internal',
+        selector: 'import',
+        elementNamePattern: ['src', 'src/**', 'app', 'app/**'],
+      },
+    ],
+    groups: [
+      'side_effect',
+      'react-libs',
+      'external',
+      'builtin',
+      'project-internal',
+      'parent',
+      ['sibling', 'index'],
+      'unknown',
+    ],
+  },
+};
+
+export {oxfmt};

package/src/react.mjs

@@ -0,0 +1,19 @@
+const react = {
+  env: {
+    browser: true,
+  },
+
+  rules: {
+    'react-hooks/rules-of-hooks': ['error'],
+    'react-hooks/exhaustive-deps': ['warn'],
+    'react/prop-types': ['off'],
+    'react/display-name': ['off'],
+    'react/no-access-state-in-setstate': ['warn'],
+    'react/no-this-in-sfc': ['warn'],
+    'react/prefer-stateless-function': ['warn'],
+    'react/jsx-boolean-value': ['warn'],
+    'react/jsx-pascal-case': ['warn'],
+  },
+};
+
+export {react};