@wistia/oxlint-config 0.0.1 → 0.3.0

package/README.md

@@ -1,2 +1,107 @@
-# oxlint-config
-Wistia's Oxlint configurations
+# @wistia/oxlint-config
+
+Wistia's Oxlint configurations. This is a shared config package for [oxlint](https://oxc.rs/docs/guide/usage/linter), a fast TypeScript/Javascript linter.
+
+## How to install
+
+```bash
+yarn add -D @wistia/oxlint-config oxlint
+```
+
+## Quick start
+
+Create an `.oxlintrc.json` in your project root:
+
+**TypeScript project** (most common):
+
+```json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["./node_modules/@wistia/oxlint-config/configs/typescript.jsonc"]
+}
+```
+
+**JavaScript-only project:**
+
+```json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["./node_modules/@wistia/oxlint-config/configs/javascript.jsonc"]
+}
+```
+
+## Available configs
+
+### Base configs
+
+| Config                     | Description                                                            |
+| -------------------------- | ---------------------------------------------------------------------- |
+| `configs/javascript.jsonc` | Base config for any JavaScript project (base + import + promise rules) |
+| `configs/typescript.jsonc` | TypeScript projects (includes all JavaScript rules)                    |
+
+### Feature configs
+
+| Config                            | Description                                                     |
+| --------------------------------- | --------------------------------------------------------------- |
+| `configs/react.jsonc`             | React component and accessibility rules (react + jsx-a11y)      |
+| `configs/node.jsonc`              | Node.js-specific rules (native + eslint-plugin-n via jsPlugins) |
+| `configs/vitest.jsonc`            | Vitest testing rules (see note below)                           |
+| `configs/playwright.jsonc`        | Playwright E2E testing rules (via jsPlugins)                    |
+| `configs/storybook.jsonc`         | Storybook story conventions (via jsPlugins)                     |
+| `configs/testing-library.jsonc`   | Testing Library + jest-dom rules (via jsPlugins)                |
+| `configs/styled-components.jsonc` | Styled Components accessibility rules (via jsPlugins)           |
+
+**Note on jsPlugins configs:** Some configs use oxlint's [jsPlugins](https://oxc.rs/docs/guide/usage/linter/js-plugins) feature to load ESLint plugins for rules that don't have native oxlint equivalents. These configs require the corresponding ESLint plugin to be installed as a dev dependency in the consuming project. Check each config's rule file for the required `jsPlugins` specifiers.
+
+**Note on vitest config:** Oxlint splits vitest-related rules across two internal plugin namespaces -- `vitest/` for vitest-specific rules and `jest/` for rules that originated in eslint-plugin-jest but apply equally to vitest. The `jest/` prefix is an oxlint naming convention; it does **not** mean Jest is required or that these rules are Jest-specific.
+
+Configs are **additive** -- start with a base (`javascript` or `typescript`), then layer on feature configs as needed:
+
+````json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": [
+    "./node_modules/@wistia/oxlint-config/configs/typescript.jsonc",
+    "./node_modules/@wistia/oxlint-config/configs/react.jsonc",
+    "./node_modules/@wistia/oxlint-config/configs/vitest.jsonc"
+  ]
+}
+
+## Overriding rules
+
+Add a `rules` section to your `.oxlintrc.json` -- your rules take precedence over the shared config:
+
+```json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": [
+    "./node_modules/@wistia/oxlint-config/configs/typescript.jsonc"
+  ],
+  "rules": {
+    "eslint/no-console": "off",
+    "typescript/no-explicit-any": "off"
+  }
+}
+````
+
+## Running oxlint
+
+Add a script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "lint": "oxlint ."
+  }
+}
+```
+
+Oxlint will automatically pick up `.oxlintrc.json` from your project root.
+
+## Guidelines for adding new rules
+
+1. Preference given for autofixable rules
+2. Should not contradict existing rules
+3. Person/team adding new rules handles upgrading consumers and fixing violations
+4. Rules should always be set to `error`, never `warn` (the latter are never fixed)
+5. Add short description of rule & link to rule definition in code comments

package/configs/javascript.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'oxlint';
+import { baseRules } from '../rules/base.ts';
+import { importRules } from '../rules/import.ts';
+import { promiseRules } from '../rules/promise.ts';
+
+export default defineConfig({
+  plugins: [...baseRules.plugins, ...importRules.plugins, ...promiseRules.plugins],
+  rules: {
+    ...baseRules.rules,
+    ...importRules.rules,
+    ...promiseRules.rules,
+  },
+});

package/configs/node.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'oxlint';
+import { nodeRules } from '../rules/node.ts';
+
+export default defineConfig({
+  plugins: nodeRules.plugins,
+  jsPlugins: nodeRules.jsPlugins,
+  rules: nodeRules.rules,
+});

package/configs/playwright.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'oxlint';
+import { playwrightRules } from '../rules/playwright.ts';
+
+export default defineConfig({
+  jsPlugins: playwrightRules.jsPlugins,
+  rules: playwrightRules.rules,
+});

package/configs/react.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'oxlint';
+import { reactRules } from '../rules/react.ts';
+import { reactA11yRules } from '../rules/react-a11y.ts';
+
+export default defineConfig({
+  plugins: [...reactRules.plugins, ...reactA11yRules.plugins],
+  rules: {
+    ...reactRules.rules,
+    ...reactA11yRules.rules,
+  },
+});

package/configs/storybook.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'oxlint';
+import { storybookRules } from '../rules/storybook.ts';
+
+export default defineConfig({
+  jsPlugins: storybookRules.jsPlugins,
+  rules: storybookRules.rules,
+});

package/configs/styled-components.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'oxlint';
+import { styledComponentsRules } from '../rules/styled-components.ts';
+
+export default defineConfig({
+  jsPlugins: styledComponentsRules.jsPlugins,
+  rules: styledComponentsRules.rules,
+});

package/configs/testing-library.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'oxlint';
+import { testingLibraryRules } from '../rules/testing-library.ts';
+
+export default defineConfig({
+  jsPlugins: testingLibraryRules.jsPlugins,
+  rules: testingLibraryRules.rules,
+});

package/configs/typescript.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from 'oxlint';
+import { baseRules } from '../rules/base.ts';
+import { importRules } from '../rules/import.ts';
+import { promiseRules } from '../rules/promise.ts';
+import { typescriptRules } from '../rules/typescript.ts';
+
+export default defineConfig({
+  plugins: [
+    ...baseRules.plugins,
+    ...importRules.plugins,
+    ...promiseRules.plugins,
+    ...typescriptRules.plugins,
+  ],
+  rules: {
+    ...baseRules.rules,
+    ...importRules.rules,
+    ...promiseRules.rules,
+    ...typescriptRules.rules,
+  },
+});

package/configs/vitest.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'oxlint';
+import { vitestRules } from '../rules/vitest.ts';
+
+export default defineConfig({
+  plugins: vitestRules.plugins,
+  jsPlugins: vitestRules.jsPlugins,
+  rules: vitestRules.rules,
+});

package/index.ts

@@ -0,0 +1,27 @@
+// Types
+export type { RuleFile } from './types.ts';
+
+// Rules
+export { baseRules } from './rules/base.ts';
+export { importRules } from './rules/import.ts';
+export { promiseRules } from './rules/promise.ts';
+export { typescriptRules } from './rules/typescript.ts';
+export { reactRules } from './rules/react.ts';
+export { reactA11yRules } from './rules/react-a11y.ts';
+export { nodeRules } from './rules/node.ts';
+export { vitestRules } from './rules/vitest.ts';
+export { playwrightRules } from './rules/playwright.ts';
+export { storybookRules } from './rules/storybook.ts';
+export { styledComponentsRules } from './rules/styled-components.ts';
+export { testingLibraryRules } from './rules/testing-library.ts';
+
+// Configs
+export { default as javascriptConfig } from './configs/javascript.ts';
+export { default as typescriptConfig } from './configs/typescript.ts';
+export { default as reactConfig } from './configs/react.ts';
+export { default as nodeConfig } from './configs/node.ts';
+export { default as vitestConfig } from './configs/vitest.ts';
+export { default as playwrightConfig } from './configs/playwright.ts';
+export { default as storybookConfig } from './configs/storybook.ts';
+export { default as styledComponentsConfig } from './configs/styled-components.ts';
+export { default as testingLibraryConfig } from './configs/testing-library.ts';

package/package.json

@@ -1,18 +1,60 @@
 {
   "name": "@wistia/oxlint-config",
-  "version": "0.0.1",
+  "version": "0.3.0",
   "description": "Wistia's Oxlint configurations",
   "packageManager": "yarn@4.13.0",
   "type": "module",
+  "files": [
+    "configs",
+    "rules",
+    "index.ts",
+    "types.ts"
+  ],
   "exports": {
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./configs/*": "./configs/*",
+    "./rules/*": "./rules/*",
+    ".": "./index.ts",
+    "./javascript": "./configs/javascript.ts",
+    "./typescript": "./configs/typescript.ts",
+    "./react": "./configs/react.ts",
+    "./node": "./configs/node.ts",
+    "./vitest": "./configs/vitest.ts"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "changeset": "changeset",
+    "format": "oxfmt .",
+    "format:ci": "oxfmt --check .",
+    "outdated": "yarn upgrade-interactive",
+    "release": "changeset publish",
+    "test": "vitest run --exclude test/validate-configs.test.mts",
+    "typecheck": "tsc --noEmit",
+    "validate": "vitest run test/validate-configs.test.mts"
   },
   "peerDependencies": {
     "oxlint": ">= 1.0.0"
   },
+  "dependencies": {
+    "@vitest/eslint-plugin": "^1.6.14",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-n": "^17.24.0",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-playwright": "^2.10.1",
+    "eslint-plugin-storybook": "^10.3.4",
+    "eslint-plugin-styled-components": "^0.0.0",
+    "eslint-plugin-styled-components-a11y": "^2.2.1",
+    "eslint-plugin-testing-library": "^7.16.2"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.30.0",
+    "eslint": "^10.2.0",
+    "oxfmt": "^0.43.0",
+    "oxlint": "^1.58.0",
+    "storybook": "^10.3.4",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.2"
+  },
   "engines": {
     "node": "^20.19.0 || ^22.13.0 || >=24"
   },