config-vp 1.1.0 → 1.2.0

package/README.md

@@ -47,13 +47,13 @@ This also pulls in everything the config needs (`oxlint`, `oxfmt`, and the lint
 **2. Create `vite.config.ts`:**
 
 ```ts
-import { defineConfig } from 'config-vp';
+import { defineVitePlusConfig } from 'config-vp';
 
-const config = defineConfig({ type: 'lib' });
+const config = defineVitePlusConfig({ type: 'lib' });
 export default config;
 ```
 
-> **Important:** Assign to a `const` and export it — don't write `export default defineConfig(...)` inline. `vp` reads your default export statically to discover tasks; a direct call hides them and `vp run` reports "Task not found". See [Troubleshooting](#troubleshooting).
+> **Important:** Assign to a `const` and export it — don't write `export default defineVitePlusConfig(...)` inline. `vp` reads your default export statically to discover tasks; a direct call hides them and `vp run` reports "Task not found". See [Troubleshooting](#troubleshooting).
 
 **3. Run something:**
 
@@ -83,38 +83,32 @@ Set `type` to match what you're building. It drives Vue lint rules, library pack
 
 Customize with the `config` hook — it receives the fully built config (see [Customizing](#customizing)).
 
-**Library** — dual ESM + CJS output:
+**Plain package** — lint + format + tests only, no build/dev (e.g. a config or scripts-only package). Just call `defineVitePlusConfig()` with no `type`:
 
 ```ts
-import { defineConfig } from 'config-vp';
+import { defineVitePlusConfig } from 'config-vp';
 
-const config = defineConfig({
-  type: 'lib',
-  config: c => {
-    c.pack = {
-      ...c.pack,
-      entry: ['src/index.ts'],
-      format: ['esm', 'cjs'],
-    };
-  },
-});
+const config = defineVitePlusConfig();
 export default config;
 ```
 
-**Vue library** — same, with `type: 'lib:vue'` for SFC/template lint rules.
+**Vue app** — a Vite-based Vue application, with plugins and a path alias:
 
 ```ts
-import { defineConfig } from 'config-vp';
+import vue from '@vitejs/plugin-vue';
+import { defineVitePlusConfig } from 'config-vp';
+import { fileURLToPath, URL } from 'node:url';
+import vueDevTools from 'vite-plugin-vue-devtools';
 
-const config = defineConfig({
-  type: 'lib:vue',
-  config: c => {
-    c.pack = {
-      ...c.pack,
-      entry: ['src/index.ts'],
-      format: ['esm', 'cjs'],
-    };
-  },
+const config = defineVitePlusConfig({
+  type: 'vue',
+  config: c => ({
+    ...c,
+    plugins: [vue(), vueDevTools()],
+    resolve: {
+      alias: { '@': fileURLToPath(new URL('./src', import.meta.url)) },
+    },
+  }),
 });
 export default config;
 ```
@@ -124,9 +118,9 @@ export default config;
 ```ts
 // nuxt.config.vite.ts
 import type { NuxtConfig } from 'nuxt/schema';
-import { defineConfig } from 'config-vp';
+import { defineVitePlusConfig } from 'config-vp';
 
-export const vite = defineConfig({
+export const vite = defineVitePlusConfig({
   type: 'nuxt:spa', // or 'nuxt:ssr'
   config: c => {
     // any Vite/vite-plus options the app needs, e.g. plugins, define, test, …
@@ -144,12 +138,39 @@ export default defineNuxtConfig({ vite });
 
 The `export const vite = …` form is itself a const export, so `vp` discovers any tasks you add in the `config` hook.
 
-**Plain package** — lint + format + tests only, no build/dev (e.g. a config or scripts-only package). Just call `defineConfig()` with no `type`:
+**Library** — dual ESM + CJS output:
 
 ```ts
-import { defineConfig } from 'config-vp';
+import { defineVitePlusConfig } from 'config-vp';
 
-const config = defineConfig();
+const config = defineVitePlusConfig({
+  type: 'lib',
+  config: c => {
+    c.pack = {
+      ...c.pack,
+      entry: ['src/index.ts'],
+      format: ['esm', 'cjs'],
+    };
+  },
+});
+export default config;
+```
+
+**Vue library** — same, with `type: 'lib:vue'` for SFC/template lint rules.
+
+```ts
+import { defineVitePlusConfig } from 'config-vp';
+
+const config = defineVitePlusConfig({
+  type: 'lib:vue',
+  config: c => {
+    c.pack = {
+      ...c.pack,
+      entry: ['src/index.ts'],
+      format: ['esm', 'cjs'],
+    };
+  },
+});
 export default config;
 ```
 
@@ -197,7 +218,7 @@ Run any task with `vp run <task>`. Tasks are cached and run in dependency order
 There's one customization hook: **`config`**. It receives the fully built config — lint, fmt, staged, run tasks, and (for `lib*`) pack, all already populated — and you change whatever you want with plain JS. Mutate it in place, or return a new object (a returned value wins; otherwise the mutated argument is used). It's fully typed, so autocomplete shows you exactly what's there.
 
 ```ts
-const config = defineConfig({
+const config = defineVitePlusConfig({
   type: 'lib',
   config: c => {
     c.pack = {
@@ -220,7 +241,7 @@ The hook works two ways — use whichever reads better:
 
 ```ts
 // Mutate in place and return nothing — best for a few targeted tweaks:
-defineConfig({
+defineVitePlusConfig({
   type: 'lib',
   config: c => {
     c.pack = {
@@ -231,7 +252,7 @@ defineConfig({
 });
 
 // Return a new object — best when you want to build the result explicitly:
-defineConfig({
+defineVitePlusConfig({
   type: 'lib',
   config: c => ({
     ...c,
@@ -250,7 +271,7 @@ A returned value wins; if you return nothing, the mutated argument is used. Don'
 Anything in a normal Vite / vite-plus config — `plugins`, `resolve`, `define`, `server`, `optimizeDeps`, `worker`, `test`, `build`, extra `run.tasks`, … — is just a field you set in the hook. Nothing config-vp-specific to learn; keep writing Vite config.
 
 ```ts
-const config = defineConfig({
+const config = defineVitePlusConfig({
   type: 'nuxt:spa',
   config: c => {
     c.plugins = [...tailwindcss()];
@@ -279,13 +300,13 @@ export default config;
 `ignorePatterns` sets the ignore globs for **both** the linter and the formatter. Pass an array to set the whole list, or a function to derive it from the built-in defaults:
 
 ```ts
-defineConfig({
+defineVitePlusConfig({
   type: 'lib',
   // add to the defaults:
   ignorePatterns: defaults => [...defaults, 'generated/**', 'vendor/**'],
 });
 
-defineConfig({
+defineVitePlusConfig({
   type: 'lib',
   // …or set the list outright:
   ignorePatterns: ['only-this/**'],
@@ -297,7 +318,7 @@ defineConfig({
 A `lib*` type includes packaging by default. To skip it, delete `pack` in the hook:
 
 ```ts
-defineConfig({
+defineVitePlusConfig({
   type: 'lib',
   config: c => {
     delete c.pack;
@@ -327,7 +348,7 @@ The base list applied to both linting and formatting (override or extend it via
 
 ## API
 
-The package exports a single function, `defineConfig`, plus the types `ConfigOptions` (its argument), `ProjectType`, and `ResolvedConfig` (the value passed to the `config` hook).
+The package exports a single function, `defineVitePlusConfig`, plus the types `ConfigOptions` (its argument), `ProjectType`, and `ResolvedConfig` (the value passed to the `config` hook).
 
 ## Troubleshooting
 
@@ -337,10 +358,10 @@ Your config almost certainly uses an inline default export. `vp` discovers tasks
 
 ```ts
 // ❌ tasks are invisible to `vp run`
-export default defineConfig({ type: 'lib' });
+export default defineVitePlusConfig({ type: 'lib' });
 
 // ✅ assign, then export
-const config = defineConfig({ type: 'lib' });
+const config = defineVitePlusConfig({ type: 'lib' });
 export default config;
 ```
 

package/dist/index.d.mts

@@ -36,6 +36,6 @@ interface ConfigOptions {
    */
   config?: (config: ResolvedConfig) => ResolvedConfig | undefined;
 }
-declare function defineConfig(options?: ConfigOptions): UserConfig;
+declare function defineVitePlusConfig(options?: ConfigOptions): UserConfig;
 //#endregion
-export { ConfigOptions, ProjectType, ResolvedConfig, defineConfig };
+export { ConfigOptions, ProjectType, ResolvedConfig, defineVitePlusConfig };

package/dist/index.mjs

@@ -652,7 +652,7 @@ function mergeLintConfigs(...configs) {
 		return merged;
 	});
 }
-function defineConfig(options = {}) {
+function defineVitePlusConfig(options = {}) {
 	const t = options.type;
 	const isVue = t === "lib:vue" || t === "lib:nuxt" || t === "vue" || t === "nuxt:spa" || t === "nuxt:ssr";
 	const isLib = t === "lib" || t === "lib:vue" || t === "lib:nuxt";
@@ -680,4 +680,4 @@ function defineConfig(options = {}) {
 	return options.config ? options.config(base) ?? base : base;
 }
 //#endregion
-export { defineConfig };
+export { defineVitePlusConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config-vp",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Shared vite-plus configuration — opinionated defaults for linting, formatting, task running, staged checks, and VSCode setup. Optional Vue and pack layers with deep-merge overrides.",
   "keywords": [
     "config",