@wistia/oxlint-config 0.0.1 → 0.2.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.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/base.jsonc", "../rules/import.jsonc", "../rules/promise.jsonc"],
+}

package/configs/node.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/node.jsonc"],
+}

package/configs/playwright.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/playwright.jsonc"],
+}

package/configs/react.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/react.jsonc", "../rules/react-a11y.jsonc"],
+}

package/configs/storybook.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/storybook.jsonc"],
+}

package/configs/styled-components.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/styled-components.jsonc"],
+}

package/configs/testing-library.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/testing-library.jsonc"],
+}

package/configs/typescript.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["./javascript.jsonc", "../rules/typescript.jsonc"],
+}

package/configs/vitest.jsonc

@@ -0,0 +1,4 @@
+{
+  "$schema": "../node_modules/oxlint/configuration_schema.json",
+  "extends": ["../rules/vitest.jsonc"],
+}

package/jsoncLoader.d.mts

@@ -0,0 +1,10 @@
+/**
+ * Load and parse a JSONC file (JSON with comments and trailing commas).
+ *
+ * Node's ESM loader doesn't support `.jsonc` imports, so this resolves the
+ * path via `require.resolve`, reads the file, and parses it with `jsonc-parser`.
+ *
+ * @param specifier - A module specifier resolvable by `require.resolve`
+ * @returns The parsed JSONC content
+ */
+export declare const jsoncLoader: (specifier: string) => Record<string, unknown>;

package/jsoncLoader.mjs

@@ -0,0 +1,27 @@
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { parse } from 'jsonc-parser';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * Load and parse a JSONC file (JSON with comments and trailing commas).
+ *
+ * Node's ESM loader doesn't support `.jsonc` imports, so this resolves the
+ * path via `require.resolve`, reads the file, and parses it with `jsonc-parser`.
+ *
+ * @example
+ * ```ts
+ * import { jsoncLoader } from '@wistia/oxlint-config/jsoncLoader';
+ *
+ * const baseRules = jsoncLoader('@wistia/oxlint-config/rules/base.jsonc');
+ * ```
+ *
+ * @param {string} specifier - A module specifier resolvable by `require.resolve`
+ * @returns {Record<string, unknown>} The parsed JSONC content
+ */
+export const jsoncLoader = (specifier) => {
+  const filePath = require.resolve(specifier);
+  const raw = readFileSync(filePath, 'utf8');
+  return parse(raw);
+};

package/package.json

@@ -1,18 +1,63 @@
 {
   "name": "@wistia/oxlint-config",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Wistia's Oxlint configurations",
   "packageManager": "yarn@4.13.0",
   "type": "module",
+  "files": [
+    "configs",
+    "rules",
+    "jsoncLoader.mjs",
+    "jsoncLoader.d.mts"
+  ],
   "exports": {
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./configs/*": "./configs/*",
+    "./rules/*": "./rules/*",
+    ".": "./configs/typescript.jsonc",
+    "./javascript": "./configs/javascript.jsonc",
+    "./typescript": "./configs/typescript.jsonc",
+    "./react": "./configs/react.jsonc",
+    "./node": "./configs/node.jsonc",
+    "./vitest": "./configs/vitest.jsonc",
+    "./jsoncLoader": {
+      "types": "./jsoncLoader.d.mts",
+      "default": "./jsoncLoader.mjs"
+    }
   },
   "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.mjs",
+    "validate": "vitest run test/validate-configs.test.mjs"
   },
   "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",
+    "jsonc-parser": "^3.3.1"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.30.0",
+    "eslint": "^10.1.0",
+    "oxfmt": "^0.43.0",
+    "oxlint": "^1.58.0",
+    "storybook": "^10.3.4",
+    "vitest": "^4.1.2"
+  },
   "engines": {
     "node": "^20.19.0 || ^22.13.0 || >=24"
   },