@letstri/oxc-config 0.1.0 → 0.2.0

package/README.md

@@ -71,59 +71,65 @@ export default oxfmtConfig()
 
 ### Plugins
 
-Framework plugins are enabled automatically by detecting dependencies in the
-nearest `package.json` (`typescript`, `react`, `vue`, `next`, `vitest`, `jest`,
-`tailwind`). Toggle any of them manually — useful when the dependency lives in a
-nested workspace such as `apps/web/package.json`:
+Plugins are enabled automatically by detecting dependencies in the nearest
+`package.json`:
+
+| Dependency   | Plugins enabled     |
+| ------------ | ------------------- |
+| `typescript` | `typescript`        |
+| `react`      | `react`, `jsx-a11y` |
+| `vue`        | `vue`               |
+| `next`       | `nextjs`            |
+| `vitest`     | `vitest`            |
+| `jest`       | `jest`              |
+
+Detection only reads the **nearest** `package.json`. If a dependency isn't found
+there — e.g. it lives in a nested workspace like `apps/web/package.json`, or is
+hoisted somewhere the scan doesn't see — its plugin won't be enabled. Add it
+manually via `plugins`:
 
 ```ts
 export default oxlintConfig({
-  vue: true, // force on
-  jest: false, // force off
+  plugins: ['vue'],
 })
 ```
 
-### Tailwind
-
-`tailwind: true` enables [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss)
-(auto-detected from a `tailwindcss` dependency). The plugin is an **optional peer
-dependency** — install it yourself:
-
-```bash
-pnpm add -D eslint-plugin-better-tailwindcss
-```
+### Overrides
 
-If Tailwind is enabled but the plugin is missing, the config logs a reminder and
-skips Tailwind linting instead of crashing. Point the plugin at your Tailwind
-entry CSS so it can resolve class names:
+Anything you pass to `oxlintConfig` / `oxfmtConfig` is deep-merged over the base
+config via [defu](https://github.com/unjs/defu):
 
 ```ts
 export default oxlintConfig({
-  tailwind: true,
-  override: {
-    settings: {
-      'better-tailwindcss': {
-        entryPoint: 'src/styles/globals.css',
-      },
-    },
+  rules: {
+    'no-console': 'off',
   },
 })
 ```
 
-### Overrides
+### Tailwind
 
-`override` is deep-merged over the base config via [defu](https://github.com/unjs/defu):
+`tailwind(options?)` returns a config chunk for
+[`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
+Spread it into `oxlintConfig`:
 
 ```ts
+import { oxlintConfig, tailwind } from '@letstri/oxc-config'
+
 export default oxlintConfig({
-  override: {
-    rules: {
-      'no-console': 'off',
-    },
-  },
+  ...tailwind({ entryPoint: 'app/globals.css' }),
 })
 ```
 
+`entryPoint` is your Tailwind entry CSS, so the plugin can resolve class names. The plugin is an **optional peer dependency** — install it yourself:
+
+```bash
+pnpm add -D eslint-plugin-better-tailwindcss
+```
+
+If the plugin is missing, `tailwind()` logs a reminder and returns an empty
+config instead of crashing oxlint.
+
 ## Editor setup
 
 Both editors use the official [oxc](https://oxc.rs) tooling — `oxlint` for

package/dist/index.d.mts

@@ -3,59 +3,59 @@ import { defineConfig as defineConfig$1 } from "oxlint";
 //#region src/index.d.ts
 type OxlintOptions = Parameters<typeof defineConfig$1>[0];
 type OxfmtOptions = Parameters<typeof defineConfig>[0];
-declare const pluginToggles: {
-  typescript: {
-    packages: string[];
-    plugins: "typescript"[];
-  };
-  react: {
-    packages: string[];
-    plugins: ("react" | "jsx-a11y" | "react-perf")[];
-  };
-  vue: {
-    packages: string[];
-    plugins: "vue"[];
-  };
-  next: {
-    packages: string[];
-    plugins: "nextjs"[];
-  };
-  vitest: {
-    packages: string[];
-    plugins: "vitest"[];
-  };
-  jest: {
-    packages: string[];
-    plugins: "jest"[];
-  };
-};
-type ToggleName = keyof typeof pluginToggles;
-interface OxlintConfigOptions extends Partial<Record<ToggleName, boolean>> {
+/**
+ * Build an oxlint config.
+ *
+ * Plugins are auto-enabled by detecting their package (`typescript`, `react`,
+ * `vue`, `next`, `vitest`, `jest`) in the nearest `package.json`. To enable a
+ * plugin whose dependency lives elsewhere — e.g. a nested workspace like
+ * `apps/web/package.json` — add it through `overrides.plugins`.
+ *
+ * `overrides` is deep-merged over the base config via defu.
+ *
+ * @example
+ * ```ts
+ * // auto-detect from the current package.json
+ * export default oxlintConfig()
+ * ```
+ * @example
+ * ```ts
+ * // enable a plugin by hand, tweak a rule
+ * export default oxlintConfig({ plugins: ['vue'], rules: { 'no-console': 'off' } })
+ * ```
+ * @example
+ * ```ts
+ * // add Tailwind linting
+ * export default oxlintConfig({ ...tailwind('app/globals.css') })
+ * ```
+ */
+declare function oxlintConfig(overrides?: OxlintOptions): OxlintOptions;
+interface TailwindOptions {
   /**
-   * Enable `eslint-plugin-better-tailwindcss`. Auto-detected from a `tailwindcss`
-   * dependency; set it explicitly when Tailwind lives in a nested workspace.
-   *
-   * The plugin is an optional peer dependency — install it yourself
-   * (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, a warning
-   * is logged and Tailwind linting is skipped. Point the plugin at your entry
-   * CSS via `override.settings`.
-   */
-  tailwind?: boolean;
-  /**
-   * Deep-merged over the base config via defu.
+   * Path to the Tailwind entry CSS. Required — the plugin needs it to resolve
+   * class names.
    */
-  override?: OxlintOptions;
+  entryPoint: string;
   /**
-   * Directory whose `package.json` is scanned to auto-detect plugins.
+   * Directory scanned to check the plugin is installed.
    *
    * @default process.cwd()
    */
   cwd?: string;
 }
-interface OxfmtConfigOptions {
-  override?: OxfmtOptions;
-}
-declare function oxlintConfig(options?: OxlintConfigOptions): OxlintOptions;
-declare function oxfmtConfig({ override }?: OxfmtConfigOptions): OxfmtOptions;
+/**
+ * Tailwind linting via [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
+ * Spread the result into {@link oxlintConfig}:
+ *
+ * ```ts
+ * export default oxlintConfig({ ...tailwind({ entryPoint: 'app/globals.css' }) })
+ * ```
+ *
+ * The plugin is an optional peer dependency — install it yourself
+ * (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, a warning
+ * is logged and an empty config is returned so oxlint does not crash.
+ */
+declare function tailwind({ entryPoint, cwd }: TailwindOptions): OxlintOptions;
+declare function oxfmtConfig(overrides?: OxfmtOptions): OxfmtOptions;
 //#endregion
-export { oxfmtConfig, oxlintConfig };
+export { oxfmtConfig, oxlintConfig, tailwind };

package/dist/index.mjs

@@ -489,18 +489,19 @@ const basePlugins = [
 	"promise",
 	"oxc"
 ];
-const pluginToggles = {
+const TAILWIND_PLUGIN = "eslint-plugin-better-tailwindcss";
+/**
+* Map of a dependency to the oxlint plugins it enables. A plugin is registered
+* when any of its packages is found in the nearest `package.json`.
+*/
+const pluginDetectors = {
 	typescript: {
 		packages: ["typescript"],
 		plugins: ["typescript"]
 	},
 	react: {
 		packages: ["react"],
-		plugins: [
-			"react",
-			"jsx-a11y",
-			"react-perf"
-		]
+		plugins: ["react", "jsx-a11y"]
 	},
 	vue: {
 		packages: ["vue"],
@@ -519,7 +520,6 @@ const pluginToggles = {
 		plugins: ["jest"]
 	}
 };
-const tailwindConfig = defineConfig$1({ jsPlugins: ["eslint-plugin-better-tailwindcss"] });
 function getInstalledPackages(cwd) {
 	const names = /* @__PURE__ */ new Set();
 	try {
@@ -532,22 +532,21 @@ function getInstalledPackages(cwd) {
 	} catch {}
 	return names;
 }
-function resolvePlugins(options, installed) {
+function resolvePlugins(cwd) {
+	const installed = getInstalledPackages(cwd);
 	const plugins = [...basePlugins];
-	for (const name of Object.keys(pluginToggles)) {
-		const toggle = pluginToggles[name];
-		if (options[name] ?? toggle.packages.some((pkg) => installed.has(pkg))) plugins.push(...toggle.plugins);
-	}
+	for (const { packages, plugins: enabled } of Object.values(pluginDetectors)) if (packages.some((pkg) => installed.has(pkg))) plugins.push(...enabled);
 	return [...new Set(plugins)];
 }
 /**
 * Build an oxlint config.
 *
-* Framework plugins (`typescript`, `react`, `vue`, `next`, `vitest`, `jest`,
-* `tailwind`) are auto-enabled by detecting their package in the nearest
-* `package.json`. If a dependency is not found there — e.g. it lives in a nested
-* workspace like `apps/web/package.json` — its plugin stays off, so enable it
-* manually:
+* Plugins are auto-enabled by detecting their package (`typescript`, `react`,
+* `vue`, `next`, `vitest`, `jest`) in the nearest `package.json`. To enable a
+* plugin whose dependency lives elsewhere — e.g. a nested workspace like
+* `apps/web/package.json` — add it through `overrides.plugins`.
+*
+* `overrides` is deep-merged over the base config via defu.
 *
 * @example
 * ```ts
@@ -556,33 +555,52 @@ function resolvePlugins(options, installed) {
 * ```
 * @example
 * ```ts
-* // dep lives in a nested workspace — turn the plugin on by hand
-* export default oxlintConfig({ vue: true })
+* // enable a plugin by hand, tweak a rule
+* export default oxlintConfig({ plugins: ['vue'], rules: { 'no-console': 'off' } })
 * ```
 * @example
 * ```ts
-* // Tailwind, pointed at the entry CSS so classes can be resolved
-* export default oxlintConfig({
-*   tailwind: true,
-*   override: {
-*     settings: { 'better-tailwindcss': { entryPoint: 'src/styles/globals.css' } },
-*   },
-* })
+* // add Tailwind linting
+* export default oxlintConfig({ ...tailwind('app/globals.css') })
 * ```
 */
-const TAILWIND_PLUGIN = "eslint-plugin-better-tailwindcss";
-function oxlintConfig(options = {}) {
-	const { override = {} } = options;
-	const installed = getInstalledPackages(options.cwd ?? process.cwd());
-	let tailwind = options.tailwind ?? installed.has("tailwindcss");
-	if (tailwind && !installed.has(TAILWIND_PLUGIN)) {
+function oxlintConfig(overrides = {}) {
+	return defu(overrides, { plugins: resolvePlugins(process.cwd()) }, baseOxlintConfig);
+}
+/**
+* Tailwind linting via [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
+* Spread the result into {@link oxlintConfig}:
+*
+* ```ts
+* export default oxlintConfig({ ...tailwind({ entryPoint: 'app/globals.css' }) })
+* ```
+*
+* The plugin is an optional peer dependency — install it yourself
+* (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, a warning
+* is logged and an empty config is returned so oxlint does not crash.
+*/
+function tailwind({ entryPoint, cwd = process.cwd() }) {
+	if (!getInstalledPackages(cwd).has(TAILWIND_PLUGIN)) {
 		console.warn(`[@letstri/oxc-config] Tailwind linting needs "${TAILWIND_PLUGIN}". Install it: pnpm add -D ${TAILWIND_PLUGIN}`);
-		tailwind = false;
+		return {};
 	}
-	return defu(override, { plugins: resolvePlugins(options, installed) }, tailwind ? tailwindConfig : {}, baseOxlintConfig);
+	return defineConfig$1({
+		jsPlugins: [TAILWIND_PLUGIN],
+		settings: { "better-tailwindcss": { entryPoint } },
+		rules: {
+			"better-tailwindcss/enforce-consistent-class-order": "error",
+			"better-tailwindcss/enforce-consistent-line-wrapping": "off",
+			"better-tailwindcss/no-unnecessary-whitespace": "off",
+			"better-tailwindcss/enforce-canonical-classes": "error",
+			"better-tailwindcss/no-conflicting-classes": "error",
+			"better-tailwindcss/no-deprecated-classes": "error",
+			"better-tailwindcss/no-duplicate-classes": "error",
+			"better-tailwindcss/no-unknown-classes": "error"
+		}
+	});
 }
-function oxfmtConfig({ override = {} } = {}) {
-	return defu(override, baseOxfmtConfig);
+function oxfmtConfig(overrides = {}) {
+	return defu(overrides, baseOxfmtConfig);
 }
 //#endregion
-export { oxfmtConfig, oxlintConfig };
+export { oxfmtConfig, oxlintConfig, tailwind };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letstri/oxc-config",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Opinionated Oxlint and Oxfmt configs",
   "homepage": "https://github.com/letstri/oxc-config#readme",
   "bugs": {
@@ -27,19 +27,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "check-types": "tsc --noEmit",
-    "lint": "oxlint -c oxlint.config.ts",
-    "lint:fix": "oxlint -c oxlint.config.ts --fix",
-    "format": "oxfmt -c oxfmt.config.ts",
-    "format:check": "oxfmt -c oxfmt.config.ts --check",
-    "check": "run-p lint check-types format:check",
-    "update": "taze -r -I major",
-    "prepare": "husky",
-    "prepublishOnly": "pnpm run build"
-  },
   "dependencies": {
     "defu": "^6.1.7"
   },
@@ -66,5 +53,15 @@
   "engines": {
     "node": ">=22"
   },
-  "packageManager": "pnpm@11.11.0"
-}
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "check-types": "tsc --noEmit",
+    "lint": "oxlint -c oxlint.config.ts",
+    "lint:fix": "oxlint -c oxlint.config.ts --fix",
+    "format": "oxfmt -c oxfmt.config.ts",
+    "format:check": "oxfmt -c oxfmt.config.ts --check",
+    "check": "run-p lint check-types format:check",
+    "update": "taze -r -I major"
+  }
+}