@letstri/oxc-config 0.2.1 → 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,33 +96,34 @@ 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({ 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` (required) 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

package/dist/index.d.mts

@@ -8,7 +8,10 @@ type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
  * 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`.
+ *
+ * Pass any number of config objects; they are deep-merged (arrays concatenated),
+ * so pieces like {@link tailwind} compose without clobbering each other.
  *
  * @example
  * ```ts
@@ -22,15 +25,22 @@ type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
  * ```
  * @example
  * ```ts
- * // add Tailwind linting
- * export default oxlintConfig({ ...tailwind({ entryPoint: '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$1): OxlintOptions$1;
+declare function oxlintConfig(...overrides: OxlintOptions$1[]): OxlintOptions$1;
 //#endregion
 //#region src/oxfmt.d.ts
 type OxfmtOptions = Parameters<typeof defineConfig$1>[0];
-declare function oxfmtConfig(overrides?: OxfmtOptions): OxfmtOptions;
+/**
+ * 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];
@@ -49,10 +59,10 @@ interface TailwindOptions {
 }
 /**
  * Tailwind linting via [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
- * Spread the result into `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

package/dist/index.mjs

@@ -534,7 +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`.
+*
+* Pass any number of config objects; they are deep-merged (arrays concatenated),
+* so pieces like {@link tailwind} compose without clobbering each other.
 *
 * @example
 * ```ts
@@ -548,34 +551,42 @@ function resolvePlugins(cwd) {
 * ```
 * @example
 * ```ts
-* // add Tailwind linting
-* export default oxlintConfig({ ...tailwind({ entryPoint: '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"
 });
-function oxfmtConfig(overrides = {}) {
-	return defu(overrides, baseOxfmtConfig);
+/**
+* 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 `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

package/package.json

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