@letstri/oxc-config 0.4.0 → 0.6.0

package/README.md

@@ -13,53 +13,24 @@ Opinionated, shared [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and [o
 npm i -D @letstri/oxc-config oxlint oxfmt
 ```
 
-Then scaffold the config files and editor settings with the `oxc-config` CLI:
+Then scaffold everything with the `oxc-config` CLI:
 
 ```bash
-npx oxc-config config    # create oxlint.config.ts + oxfmt.config.ts
-npx oxc-config editors   # write .vscode + .zed settings
+npx oxc-config init
 ```
 
-Run `oxc-config --help` for all commands. Details: [Usage](#usage) and
-[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'
+`init` prompts you to pick what to set up — oxlint config, oxfmt config, VS Code,
+Zed. Pass flags to skip the prompt (useful in CI/scripts):
 
-   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.
-````
+```bash
+npx oxc-config init --oxlint --oxfmt   # just the config files
+npx oxc-config init --vscode --zed     # just the editor settings
+```
 
-</details>
+With flags, only the chosen targets run; with none in a non-interactive shell,
+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).
 
 ## Usage
 
@@ -117,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' }),
 )
 ```
 
@@ -141,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:
@@ -150,23 +121,19 @@ 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
 
 Both editors use the official [oxc](https://oxc.rs) tooling — `oxlint` for
 linting and `oxfmt` for formatting — replacing ESLint and Prettier.
 
-The `oxc-config editors` command writes (or updates) the editor configs for you,
-deep-merging into any existing files so your other settings are kept:
+`oxc-config init` writes (or updates) the editor configs for you, deep-merging
+into any existing files so your other settings are kept:
 
 ```bash
 # both editors
-pnpm exec oxc-config editors
-
-# or just one
-pnpm exec oxc-config editors --vscode
-pnpm exec oxc-config editors --zed
+pnpm exec oxc-config init --vscode --zed
 ```
 
 It's idempotent — safe to re-run to pull the latest recommended settings.
@@ -174,13 +141,13 @@ It's idempotent — safe to re-run to pull the latest recommended settings.
 ### VS Code
 
 Install the [`oxc.oxc-vscode`](https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode)
-extension (`oxc-config editors --vscode` also adds it to `.vscode/extensions.json`). The
-CLI writes `.vscode/settings.json` — oxlint as linter, oxfmt as the default
-formatter with format-on-save, and Prettier's import organization turned off.
+extension (`init --vscode` also adds it to `.vscode/extensions.json`). It writes
+`.vscode/settings.json` — oxlint as linter, oxfmt as the default formatter with
+format-on-save, and Prettier's import organization turned off.
 
 ### Zed
 
 Zed ships with the oxc language servers built in, so no extension is needed.
-`oxc-config editors --zed` writes `.zed/settings.json` — oxfmt as the formatter (with
+`init --zed` writes `.zed/settings.json` — oxfmt as the formatter (with
 `source.fixAll.oxc` on save for JS/TS) and Prettier disabled, across the file
 types oxfmt supports.

package/dist/cli.mjs

@@ -2,8 +2,8 @@
 import process from "node:process";
 import { createDefu } from "defu";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { dirname, resolve } from "node:path";
-import { boolean, command, run } from "@drizzle-team/brocli";
+import { dirname } from "node:path";
+import { cancel, isCI, isCancel, multiselect } from "@clack/prompts";
 import { parse } from "jsonc-parser";
 //#region src/editors.ts
 /**
@@ -73,93 +73,93 @@ const zedSettings = {
 };
 //#endregion
 //#region src/cli.ts
-/**
-* Like defu, but arrays are merged as a de-duplicated union instead of being
-* concatenated — keeps updates idempotent and preserves user-added entries.
-*/
-const mergeConfig = createDefu((obj, key, value) => {
+const log = (message) => process.stdout.write(`${message}\n`);
+const merge = createDefu((obj, key, value) => {
 	const current = obj[key];
 	if (Array.isArray(current) && Array.isArray(value)) {
-		const seen = /* @__PURE__ */ new Set();
-		obj[key] = [...value, ...current].filter((item) => {
-			const id = JSON.stringify(item);
-			if (seen.has(id)) return false;
-			seen.add(id);
-			return true;
-		});
+		const union = [...value, ...current].map((item) => JSON.stringify(item));
+		obj[key] = [...new Set(union)].map((item) => JSON.parse(item));
 		return true;
 	}
 	return false;
 });
-function readJsonc(path) {
-	if (!existsSync(path)) return {};
-	return parse(readFileSync(path, "utf-8"), [], { allowTrailingComma: true }) ?? {};
-}
-/** Deep-merge `base` into the JSON(C) file at `path`, creating it if absent. */
-function mergeJsonFile(path, base) {
+function mergeJson(path, base) {
 	const existed = existsSync(path);
-	const merged = mergeConfig(base, readJsonc(path));
+	const current = existed ? parse(readFileSync(path, "utf-8"), [], { allowTrailingComma: true }) : {};
 	mkdirSync(dirname(path), { recursive: true });
-	writeFileSync(path, `${JSON.stringify(merged, null, 2)}\n`);
+	writeFileSync(path, `${JSON.stringify(merge(base, current ?? {}), null, 2)}\n`);
 	return existed ? "updated" : "created";
 }
-/** Write `content` to `path`, skipping an existing file unless `force`. */
-function writeFile(path, content, force) {
+function writeConfig(path, content, force) {
 	const existed = existsSync(path);
 	if (existed && !force) return "skipped";
-	mkdirSync(dirname(path), { recursive: true });
 	writeFileSync(path, content);
 	return existed ? "overwritten" : "created";
 }
-const OXLINT_CONFIG = `import { oxlintConfig } from '@letstri/oxc-config'
+const template = (fn) => `import { ${fn} } from '@letstri/oxc-config'\n\nexport default ${fn}()\n`;
+const TARGETS = {
+	oxlint: {
+		label: "oxlint.config.ts",
+		run: (force) => `oxlint: ${writeConfig("oxlint.config.ts", template("oxlintConfig"), force)}`
+	},
+	oxfmt: {
+		label: "oxfmt.config.ts",
+		run: (force) => `oxfmt: ${writeConfig("oxfmt.config.ts", template("oxfmtConfig"), force)}`
+	},
+	vscode: {
+		label: "VS Code settings (.vscode)",
+		run: () => `vscode: ${mergeJson(".vscode/settings.json", vscodeSettings)} settings, ${mergeJson(".vscode/extensions.json", vscodeExtensions)} extensions`
+	},
+	zed: {
+		label: "Zed settings (.zed)",
+		run: () => `zed: ${mergeJson(".zed/settings.json", zedSettings)}`
+	}
+};
+const ALL = Object.keys(TARGETS);
+async function pickTargets(flags) {
+	const flagged = ALL.filter((target) => flags.has(`--${target}`));
+	if (flagged.length > 0) return flagged;
+	if (isCI() || !process.stdout.isTTY) return ALL;
+	const selected = await multiselect({
+		message: "What do you want to set up?",
+		options: ALL.map((value) => ({
+			value,
+			label: TARGETS[value].label
+		})),
+		initialValues: ALL,
+		required: true
+	});
+	if (isCancel(selected)) {
+		cancel("Cancelled.");
+		return null;
+	}
+	return selected;
+}
+function version() {
+	const url = new URL("../package.json", import.meta.url);
+	return JSON.parse(readFileSync(url, "utf-8")).version;
+}
+const HELP = `oxc-config — set up @letstri/oxc-config in your project
 
-export default oxlintConfig()
-`;
-const OXFMT_CONFIG = `import { oxfmtConfig } from '@letstri/oxc-config'
+Usage:
+  oxc-config [flags]
 
-export default oxfmtConfig()
-`;
-function version() {
-	try {
-		return JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf-8")).version ?? "0.0.0";
-	} catch {
-		return "0.0.0";
-	}
+Flags (default: prompt for what to set up):
+  --oxlint       create oxlint.config.ts
+  --oxfmt        create oxfmt.config.ts
+  --vscode       write .vscode settings
+  --zed          write .zed settings
+  -f, --force    overwrite existing config files
+  -h, --help     show this help
+  -v, --version  show version`;
+const argv = process.argv.slice(2);
+if (argv.includes("--help") || argv.includes("-h")) log(HELP);
+else if (argv.includes("--version") || argv.includes("-v")) log(version());
+else {
+	const flags = new Set(argv);
+	const force = flags.has("--force") || flags.has("-f");
+	const targets = await pickTargets(flags);
+	for (const target of targets ?? []) log(TARGETS[target].run(force));
 }
-run([command({
-	name: "config",
-	desc: "Create oxlint.config.ts and oxfmt.config.ts",
-	options: { force: boolean().alias("f").desc("Overwrite existing files").default(false) },
-	handler: ({ force }) => {
-		const cwd = process.cwd();
-		const lint = writeFile(resolve(cwd, "oxlint.config.ts"), OXLINT_CONFIG, force);
-		const fmt = writeFile(resolve(cwd, "oxfmt.config.ts"), OXFMT_CONFIG, force);
-		process.stdout.write(`config: ${lint} oxlint.config.ts, ${fmt} oxfmt.config.ts\n`);
-	}
-}), command({
-	name: "editors",
-	desc: "Write/update VS Code and Zed editor configs (deep-merged into existing files)",
-	options: {
-		vscode: boolean().desc("Only VS Code").default(false),
-		zed: boolean().desc("Only Zed").default(false)
-	},
-	handler: ({ vscode, zed }) => {
-		const both = !vscode && !zed;
-		const cwd = process.cwd();
-		if (both || vscode) {
-			const s = mergeJsonFile(resolve(cwd, ".vscode/settings.json"), vscodeSettings);
-			const e = mergeJsonFile(resolve(cwd, ".vscode/extensions.json"), vscodeExtensions);
-			process.stdout.write(`vscode: ${s} .vscode/settings.json, ${e} .vscode/extensions.json\n`);
-		}
-		if (both || zed) {
-			const s = mergeJsonFile(resolve(cwd, ".zed/settings.json"), zedSettings);
-			process.stdout.write(`zed: ${s} .zed/settings.json\n`);
-		}
-	}
-})], {
-	name: "oxc-config",
-	description: "Set up @letstri/oxc-config in your project",
-	version: version()
-});
 //#endregion
 export {};

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.4.0",
+  "version": "0.6.0",
   "description": "Opinionated Oxlint and Oxfmt configs",
   "homepage": "https://github.com/letstri/oxc-config#readme",
   "bugs": {
@@ -31,7 +31,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@drizzle-team/brocli": "^0.12.0",
+    "@clack/prompts": "^1.7.0",
     "defu": "^6.1.7",
     "jsonc-parser": "^3.3.1"
   },