@letstri/oxc-config 0.2.0 → 0.3.1

package/README.md

@@ -4,8 +4,8 @@ Opinionated, shared [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and [o
 
 > [!NOTE]
 > This is an **opinionated** config — it ships a curated set of rules and
-> formatting defaults meant to work out of the box. Override anything you
-> disagree with via the [`override`](#overrides) option.
+> formatting defaults meant to work out of the box. [Override](#overrides)
+> anything you disagree with.
 
 ## Install
 
@@ -44,7 +44,7 @@ Set up @letstri/oxc-config (oxlint + oxfmt) in this project:
    - "format:check": "oxfmt --check"
 6. Framework plugins auto-enable from the nearest package.json. If a framework
    dep (react/vue/next/vitest/jest/typescript) lives in a nested workspace,
-   enable it manually, e.g. `oxlintConfig({ vue: true })`.
+   enable it manually, e.g. `oxlintConfig({ plugins: ['vue'] })`.
 7. Add the VS Code and Zed editor settings from the @letstri/oxc-config README.
 8. Run `pnpm lint` and `pnpm format` and fix anything reported.
 ````
@@ -96,39 +96,40 @@ export default oxlintConfig({
 
 ### Overrides
 
-Anything you pass to `oxlintConfig` / `oxfmtConfig` is deep-merged over the base
-config via [defu](https://github.com/unjs/defu):
+`oxlintConfig` / `oxfmtConfig` accept **any number of config objects**, all
+deep-merged over the base config via [defu](https://github.com/unjs/defu) (arrays
+are concatenated, so plugins from different pieces combine instead of
+overwriting):
 
 ```ts
-export default oxlintConfig({
-  rules: {
-    'no-console': 'off',
-  },
-})
+export default oxlintConfig({ rules: { 'no-console': 'off' } }, { plugins: ['vue'] })
 ```
 
 ### Tailwind
 
-`tailwind(options?)` returns a config chunk for
+`tailwind({ entryPoint })` returns a config chunk for
 [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
-Spread it into `oxlintConfig`:
+Pass it as an argument to `oxlintConfig`:
 
 ```ts
 import { oxlintConfig, tailwind } from '@letstri/oxc-config'
 
-export default oxlintConfig({
-  ...tailwind({ entryPoint: 'app/globals.css' }),
-})
+export default oxlintConfig(
+  { plugins: ['react', 'jsx-a11y'] },
+  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:
+Because arguments are merged (not spread), Tailwind's plugins combine with the
+ones above rather than overwriting them. `entryPoint` (required) 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.
+If the plugin is missing, `tailwind()` throws with an install hint.
 
 ## Editor setup
 

package/dist/index.d.mts

@@ -1,17 +1,17 @@
-import { defineConfig } from "oxfmt";
-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];
+import { defineConfig } from "oxlint";
+import { defineConfig as defineConfig$1 } from "oxfmt";
+//#region src/oxlint.d.ts
+type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
 /**
  * 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`.
+ * `apps/web/package.json` — add it through `plugins`.
  *
- * `overrides` is deep-merged over the base config via defu.
+ * Pass any number of config objects; they are deep-merged (arrays concatenated),
+ * so pieces like {@link tailwind} compose without clobbering each other.
  *
  * @example
  * ```ts
@@ -25,11 +25,25 @@ type OxfmtOptions = Parameters<typeof defineConfig>[0];
  * ```
  * @example
  * ```ts
- * // add Tailwind linting
- * export default oxlintConfig({ ...tailwind('app/globals.css') })
+ * // compose Tailwind — its plugins merge with the ones above, not overwrite
+ * export default oxlintConfig(
+ *   { plugins: ['react', 'jsx-a11y'] },
+ *   tailwind({ entryPoint: 'app/globals.css' }),
+ * )
  * ```
  */
-declare function oxlintConfig(overrides?: OxlintOptions): OxlintOptions;
+declare function oxlintConfig(...overrides: OxlintOptions$1[]): OxlintOptions$1;
+//#endregion
+//#region src/oxfmt.d.ts
+type OxfmtOptions = Parameters<typeof defineConfig$1>[0];
+/**
+ * Build an oxfmt config. Pass any number of config objects; they are deep-merged
+ * over the base config via defu.
+ */
+declare function oxfmtConfig(...overrides: OxfmtOptions[]): OxfmtOptions;
+//#endregion
+//#region src/tailwind.d.ts
+type OxlintOptions = Parameters<typeof defineConfig>[0];
 interface TailwindOptions {
   /**
    * Path to the Tailwind entry CSS. Required — the plugin needs it to resolve
@@ -45,17 +59,16 @@ interface TailwindOptions {
 }
 /**
  * Tailwind linting via [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
- * Spread the result into {@link oxlintConfig}:
+ * Pass the result as an argument to `oxlintConfig`:
  *
  * ```ts
- * export default oxlintConfig({ ...tailwind({ entryPoint: 'app/globals.css' }) })
+ * 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.
+ * (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, an error
+ * is thrown.
  */
 declare function tailwind({ entryPoint, cwd }: TailwindOptions): OxlintOptions;
-declare function oxfmtConfig(overrides?: OxfmtOptions): OxfmtOptions;
 //#endregion
 export { oxfmtConfig, oxlintConfig, tailwind };

package/dist/index.mjs

@@ -1,11 +1,25 @@
-import { readFileSync } from "node:fs";
-import { resolve } from "node:path";
 import process from "node:process";
 import { defu } from "defu";
-import { defineConfig } from "oxfmt";
-import { defineConfig as defineConfig$1 } from "oxlint";
-//#region src/index.ts
-const baseOxlintConfig = defineConfig$1({
+import { defineConfig } from "oxlint";
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { defineConfig as defineConfig$1 } from "oxfmt";
+//#region src/utils.ts
+function getInstalledPackages(cwd) {
+	const names = /* @__PURE__ */ new Set();
+	try {
+		const pkg = JSON.parse(readFileSync(resolve(cwd, "package.json"), "utf-8"));
+		for (const field of [
+			pkg.dependencies,
+			pkg.devDependencies,
+			pkg.peerDependencies
+		]) for (const name of Object.keys(field ?? {})) names.add(name);
+	} catch {}
+	return names;
+}
+//#endregion
+//#region src/oxlint.ts
+const baseOxlintConfig = defineConfig({
 	categories: {
 		correctness: "error",
 		suspicious: "warn",
@@ -474,13 +488,6 @@ const baseOxlintConfig = defineConfig$1({
 		}
 	]
 });
-const baseOxfmtConfig = defineConfig({
-	singleQuote: true,
-	semi: false,
-	arrowParens: "avoid",
-	sortImports: true,
-	quoteProps: "consistent"
-});
 const basePlugins = [
 	"import",
 	"unicorn",
@@ -489,11 +496,6 @@ const basePlugins = [
 	"promise",
 	"oxc"
 ];
-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"],
@@ -520,18 +522,6 @@ const pluginDetectors = {
 		plugins: ["jest"]
 	}
 };
-function getInstalledPackages(cwd) {
-	const names = /* @__PURE__ */ new Set();
-	try {
-		const pkg = JSON.parse(readFileSync(resolve(cwd, "package.json"), "utf-8"));
-		for (const field of [
-			pkg.dependencies,
-			pkg.devDependencies,
-			pkg.peerDependencies
-		]) for (const name of Object.keys(field ?? {})) names.add(name);
-	} catch {}
-	return names;
-}
 function resolvePlugins(cwd) {
 	const installed = getInstalledPackages(cwd);
 	const plugins = [...basePlugins];
@@ -544,9 +534,10 @@ function resolvePlugins(cwd) {
 * 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`.
+* `apps/web/package.json` — add it through `plugins`.
 *
-* `overrides` is deep-merged over the base config via defu.
+* Pass any number of config objects; they are deep-merged (arrays concatenated),
+* so pieces like {@link tailwind} compose without clobbering each other.
 *
 * @example
 * ```ts
@@ -560,31 +551,51 @@ function resolvePlugins(cwd) {
 * ```
 * @example
 * ```ts
-* // add Tailwind linting
-* export default oxlintConfig({ ...tailwind('app/globals.css') })
+* // compose Tailwind — its plugins merge with the ones above, not overwrite
+* export default oxlintConfig(
+*   { plugins: ['react', 'jsx-a11y'] },
+*   tailwind({ entryPoint: 'app/globals.css' }),
+* )
 * ```
 */
-function oxlintConfig(overrides = {}) {
-	return defu(overrides, { plugins: resolvePlugins(process.cwd()) }, baseOxlintConfig);
+function oxlintConfig(...overrides) {
+	return defu({}, ...overrides, { plugins: resolvePlugins(process.cwd()) }, baseOxlintConfig);
+}
+//#endregion
+//#region src/oxfmt.ts
+const baseOxfmtConfig = defineConfig$1({
+	printWidth: 100,
+	singleQuote: true,
+	semi: false,
+	arrowParens: "avoid",
+	sortImports: true,
+	quoteProps: "consistent"
+});
+/**
+* Build an oxfmt config. Pass any number of config objects; they are deep-merged
+* over the base config via defu.
+*/
+function oxfmtConfig(...overrides) {
+	return defu({}, ...overrides, baseOxfmtConfig);
 }
+//#endregion
+//#region src/tailwind.ts
+const TAILWIND_PLUGIN = "eslint-plugin-better-tailwindcss";
 /**
 * Tailwind linting via [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
-* Spread the result into {@link oxlintConfig}:
+* Pass the result as an argument to `oxlintConfig`:
 *
 * ```ts
-* export default oxlintConfig({ ...tailwind({ entryPoint: 'app/globals.css' }) })
+* 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.
+* (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, an error
+* is thrown.
 */
 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}`);
-		return {};
-	}
-	return defineConfig$1({
+	if (!getInstalledPackages(cwd).has(TAILWIND_PLUGIN)) throw new Error(`[@letstri/oxc-config] Tailwind linting needs "${TAILWIND_PLUGIN}". Install it: pnpm add -D ${TAILWIND_PLUGIN}`);
+	return defineConfig({
 		jsPlugins: [TAILWIND_PLUGIN],
 		settings: { "better-tailwindcss": { entryPoint } },
 		rules: {
@@ -599,8 +610,5 @@ function tailwind({ entryPoint, cwd = process.cwd() }) {
 		}
 	});
 }
-function oxfmtConfig(overrides = {}) {
-	return defu(overrides, baseOxfmtConfig);
-}
 //#endregion
 export { oxfmtConfig, oxlintConfig, tailwind };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letstri/oxc-config",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Opinionated Oxlint and Oxfmt configs",
   "homepage": "https://github.com/letstri/oxc-config#readme",
   "bugs": {