@letstri/oxc-config 0.5.0 → 0.6.0

package/README.md

@@ -32,44 +32,6 @@ all four run. Config files are skipped if they already exist (`--force` to
 overwrite); editor settings are deep-merged into any existing files. See
 [Editor setup](#editor-setup).
 
-## AI setup prompt
-
-Paste this into Claude Code, Cursor, or any coding agent to wire everything up:
-
-<details>
-<summary>Show prompt</summary>
-
-````text
-Set up @letstri/oxc-config (oxlint + oxfmt) in this project:
-
-1. Install dev deps: `@letstri/oxc-config oxlint oxfmt`.
-2. Remove ESLint and Prettier: their configs, deps, and scripts.
-3. Create `oxlint.config.ts`:
-   ```ts
-   import { oxlintConfig } from '@letstri/oxc-config'
-
-   export default oxlintConfig()
-   ```
-4. Create `oxfmt.config.ts`:
-   ```ts
-   import { oxfmtConfig } from '@letstri/oxc-config'
-
-   export default oxfmtConfig()
-   ```
-5. Add package.json scripts:
-   - "lint": "oxlint"
-   - "lint:fix": "oxlint --fix"
-   - "format": "oxfmt"
-   - "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({ 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.
-````
-
-</details>
-
 ## Usage
 
 `oxlint.config.ts`:
@@ -126,16 +88,16 @@ export default oxlintConfig({ rules: { 'no-console': 'off' } }, { plugins: ['vue
 
 ### Tailwind
 
-`tailwind({ entryPoint })` returns a config chunk for
+`tailwindPlugin({ entryPoint })` returns a config chunk for
 [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss).
 Pass it as an argument to `oxlintConfig`:
 
 ```ts
-import { oxlintConfig, tailwind } from '@letstri/oxc-config'
+import { oxlintConfig, tailwindPlugin } from '@letstri/oxc-config'
 
 export default oxlintConfig(
   { plugins: ['react', 'jsx-a11y'] },
-  tailwind({ entryPoint: 'app/globals.css' }),
+  tailwindPlugin({ entryPoint: 'app/globals.css' }),
 )
 ```
 
@@ -150,7 +112,7 @@ Options:
   a component library generates that the plugin can't resolve):
 
   ```ts
-  tailwind({ entryPoint: 'app/globals.css', ignoreClasses: ['toaster'] })
+  tailwindPlugin({ entryPoint: 'app/globals.css', ignoreClasses: ['toaster'] })
   ```
 
 The plugin is an **optional peer dependency** — install it yourself:
@@ -159,7 +121,7 @@ The plugin is an **optional peer dependency** — install it yourself:
 pnpm add -D eslint-plugin-better-tailwindcss
 ```
 
-If the plugin is missing, `tailwind()` throws with an install hint.
+If the plugin is missing, `tailwindPlugin()` throws with an install hint.
 
 ## Editor setup
 

package/dist/index.d.mts

@@ -1,7 +1,21 @@
 import { defineConfig } from "oxlint";
 import { defineConfig as defineConfig$1 } from "oxfmt";
 //#region src/oxlint.d.ts
-type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
+type OxlintOptions = Parameters<typeof defineConfig>[0];
+type OxlintPlugin = NonNullable<NonNullable<OxlintOptions>['plugins']>[number];
+declare const basePlugins: readonly ["import", "unicorn", "jsdoc", "node", "promise", "oxc"];
+/**
+ * Plugins always enabled by the base config — excluded from the `plugins` you
+ * can add, since listing them again is redundant.
+ */
+type BasePlugin = (typeof basePlugins)[number];
+/**
+ * Oxlint config accepted by {@link oxlintConfig}. Same as oxlint's own config,
+ * but `plugins` can't include the always-on base plugins.
+ */
+type OxlintConfig = Omit<NonNullable<OxlintOptions>, 'plugins'> & {
+  plugins?: Exclude<OxlintPlugin, BasePlugin>[];
+};
 /**
  * Build an oxlint config.
  *
@@ -10,8 +24,9 @@ type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
  * plugin whose dependency lives elsewhere — e.g. a nested workspace like
  * `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.
+ * Pass any number of config objects; they are deep-merged (arrays concatenated,
+ * with `plugins` de-duplicated), so pieces like {@link tailwindPlugin} compose
+ * without clobbering each other.
  *
  * @example
  * ```ts
@@ -28,11 +43,11 @@ type OxlintOptions$1 = Parameters<typeof defineConfig>[0];
  * // compose Tailwind — its plugins merge with the ones above, not overwrite
  * export default oxlintConfig(
  *   { plugins: ['react', 'jsx-a11y'] },
- *   tailwind({ entryPoint: 'app/globals.css' }),
+ *   tailwindPlugin({ entryPoint: 'app/globals.css' }),
  * )
  * ```
  */
-declare function oxlintConfig(...overrides: OxlintOptions$1[]): OxlintOptions$1;
+declare function oxlintConfig(...overrides: OxlintConfig[]): OxlintOptions;
 //#endregion
 //#region src/oxfmt.d.ts
 type OxfmtOptions = Parameters<typeof defineConfig$1>[0];
@@ -43,7 +58,6 @@ type OxfmtOptions = Parameters<typeof defineConfig$1>[0];
 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
@@ -67,7 +81,7 @@ interface TailwindOptions {
  * Pass the result as an argument to `oxlintConfig`:
  *
  * ```ts
- * export default oxlintConfig(tailwind({
+ * export default oxlintConfig(tailwindPlugin({
  *   entryPoint: 'app/globals.css',
  *   ignoreClasses: ['toaster'],
  * }))
@@ -77,6 +91,6 @@ interface TailwindOptions {
  * (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, an error
  * is thrown.
  */
-declare function tailwind({ entryPoint, ignoreClasses, cwd }: TailwindOptions): OxlintOptions;
+declare function tailwindPlugin({ entryPoint, ignoreClasses, cwd }: TailwindOptions): OxlintConfig;
 //#endregion
-export { oxfmtConfig, oxlintConfig, tailwind };
+export { oxfmtConfig, oxlintConfig, tailwindPlugin };

package/dist/index.mjs

@@ -536,8 +536,9 @@ function resolvePlugins(cwd) {
 * plugin whose dependency lives elsewhere — e.g. a nested workspace like
 * `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.
+* Pass any number of config objects; they are deep-merged (arrays concatenated,
+* with `plugins` de-duplicated), so pieces like {@link tailwindPlugin} compose
+* without clobbering each other.
 *
 * @example
 * ```ts
@@ -554,12 +555,14 @@ function resolvePlugins(cwd) {
 * // compose Tailwind — its plugins merge with the ones above, not overwrite
 * export default oxlintConfig(
 *   { plugins: ['react', 'jsx-a11y'] },
-*   tailwind({ entryPoint: 'app/globals.css' }),
+*   tailwindPlugin({ entryPoint: 'app/globals.css' }),
 * )
 * ```
 */
 function oxlintConfig(...overrides) {
-	return defu({}, ...overrides, { plugins: resolvePlugins(process.cwd()) }, baseOxlintConfig);
+	const merged = defu({}, ...overrides, { plugins: resolvePlugins(process.cwd()) }, baseOxlintConfig);
+	if (merged?.plugins) merged.plugins = [...new Set(merged.plugins)];
+	return merged;
 }
 //#endregion
 //#region src/oxfmt.ts
@@ -586,7 +589,7 @@ const TAILWIND_PLUGIN = "eslint-plugin-better-tailwindcss";
 * Pass the result as an argument to `oxlintConfig`:
 *
 * ```ts
-* export default oxlintConfig(tailwind({
+* export default oxlintConfig(tailwindPlugin({
 *   entryPoint: 'app/globals.css',
 *   ignoreClasses: ['toaster'],
 * }))
@@ -596,7 +599,7 @@ const TAILWIND_PLUGIN = "eslint-plugin-better-tailwindcss";
 * (`pnpm add -D eslint-plugin-better-tailwindcss`). If it is missing, an error
 * is thrown.
 */
-function tailwind({ entryPoint, ignoreClasses = [], cwd = process.cwd() }) {
+function tailwindPlugin({ entryPoint, ignoreClasses = [], cwd = process.cwd() }) {
 	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],
@@ -614,4 +617,4 @@ function tailwind({ entryPoint, ignoreClasses = [], cwd = process.cwd() }) {
 	});
 }
 //#endregion
-export { oxfmtConfig, oxlintConfig, tailwind };
+export { oxfmtConfig, oxlintConfig, tailwindPlugin };

package/package.json

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