You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@acme is itself a live npm scope, so it still reads as a real handle a
reader might try to use. @your-org is self-describing: it literally tells
readers "replace this with your own scope". Same pattern GitHub, npm,
and AWS docs use for org placeholders.
Also cleans up two descriptions that read awkwardly after the rename —
"Full Acme Corp monorepo scaffold" → "Monorepo scaffold" — since
personifying the placeholder as a company name is unhelpful when the
whole point is that it's not a company.
Touched: the RFC, docs/guide/create.md, docs/config/create.md,
packages/cli/src/create/{bin.ts, define-config.ts}, all four org
snap-tests, and the three org unit test specs. Four snap outputs
regenerated; 263 unit tests still pass.
Copy file name to clipboardExpand all lines: docs/config/create.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,12 @@ import { defineConfig } from 'vite-plus';
11
11
12
12
exportdefaultdefineConfig({
13
13
create: {
14
-
defaultTemplate: '@acme',
14
+
defaultTemplate: '@your-org',
15
15
},
16
16
});
17
17
```
18
18
19
-
Any value accepted by `vp create` as a first argument works here — `@acme` for an org picker, `@acme/web` for a direct manifest entry, `vite:application` for a built-in, etc.
19
+
Any value accepted by `vp create` as a first argument works here — `@your-org` for an org picker, `@your-org/web` for a direct manifest entry, `vite:application` for a built-in, etc.
Copy file name to clipboardExpand all lines: docs/guide/create.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Vite+ ships with these built-in templates:
35
35
36
36
- Use shorthand templates like `vite`, `@tanstack/start`, `svelte`, `next-app`, `nuxt`, `react-router`, and `vue`
37
37
- Use full package names like `create-vite` or `create-next-app`
38
-
- Use local templates such as `./tools/create-ui-component` or `@acme/generator-*`
38
+
- Use local templates such as `./tools/create-ui-component` or `@your-org/generator-*`
39
39
- Use remote templates such as `github:user/repo` or `https://github.com/user/template-repo`
40
40
41
41
Run `vp create --list` to see the built-in templates and the common shorthand templates Vite+ recognizes.
@@ -94,11 +94,11 @@ An organization can publish a curated set of templates under a single npm scope
94
94
### Pick from an org
95
95
96
96
```bash
97
-
# Open an interactive picker over @acme/create's manifest
98
-
vp create @acme
97
+
# Open an interactive picker over @your-org/create's manifest
98
+
vp create @your-org
99
99
100
100
# Run a specific manifest entry directly
101
-
vp create @acme/web
101
+
vp create @your-org/web
102
102
103
103
# Set the org as the default for a repo (see create.defaultTemplate config)
104
104
vp create
@@ -113,7 +113,7 @@ There are two common layouts. Pick the one that matches the org's template count
113
113
**Bundled (recommended for most orgs).** All templates live as subdirectories of `@org/create` itself. Manifest entries use relative `./path` values. One repo, one publish, one versioning story — the same pattern used by `create-vite` and `create-next-app`.
@@ -141,20 +141,20 @@ The manifest lives at `vp.templates` in `@org/create`'s `package.json`:
141
141
142
142
```json
143
143
{
144
-
"name": "@acme/create",
144
+
"name": "@your-org/create",
145
145
"version": "1.0.0",
146
146
"vp": {
147
147
"templates": [
148
148
{
149
149
"name": "monorepo",
150
-
"description": "Full Acme Corp monorepo",
151
-
"template": "@acme/template-monorepo",
150
+
"description": "Monorepo",
151
+
"template": "@your-org/template-monorepo",
152
152
"monorepo": true
153
153
},
154
154
{
155
155
"name": "web",
156
156
"description": "Web app template (Vite + React)",
157
-
"template": "@acme/template-web",
157
+
"template": "@your-org/template-web",
158
158
"keywords": ["web", "react", "app"]
159
159
},
160
160
{
@@ -177,7 +177,7 @@ Each entry supports:
177
177
|`keywords`| no | Filter terms for picker search. |
178
178
|`monorepo`| no | If `true`, marks this entry as a monorepo-creating template. Hidden from the picker when `vp create` runs inside an existing monorepo, mirroring the built-in `vite:monorepo` filter. |
179
179
180
-
An invalid manifest is a hard error, not a silent fall-through — a maintainer who shipped a manifest should hear about the offending field, e.g. `@acme/create: vp.templates[2].template must be a non-empty string`.
180
+
An invalid manifest is a hard error, not a silent fall-through — a maintainer who shipped a manifest should hear about the offending field, e.g. `@your-org/create: vp.templates[2].template must be a non-empty string`.
181
181
182
182
### Bundled subdirectory templates
183
183
@@ -191,11 +191,11 @@ Commit this in `vite.config.ts` at the project root:
191
191
import { defineConfig } from'vite-plus';
192
192
193
193
exportdefaultdefineConfig({
194
-
create: { defaultTemplate: '@acme' },
194
+
create: { defaultTemplate: '@your-org' },
195
195
});
196
196
```
197
197
198
-
Now `vp create` (with no argument) drops straight into the `@acme` picker. See [`create.defaultTemplate`](/config/create) for details.
198
+
Now `vp create` (with no argument) drops straight into the `@your-org` picker. See [`create.defaultTemplate`](/config/create) for details.
199
199
200
200
The picker always appends a trailing **Vite+ built-in templates** entry so `vite:monorepo` / `vite:application` / `vite:library` / `vite:generator` stay reachable from the picker — selecting it routes to the standard built-in flow. For scripts and CI, explicit specifiers (`vp create vite:library`) bypass the configured default.
201
201
@@ -204,16 +204,16 @@ The picker always appends a trailing **Vite+ built-in templates** entry so `vite
204
204
`vp create @org --no-interactive` prints a stable, fixed-column table of the manifest (name, description, resolved template specifier) and exits 1. The output is machine-parseable, so scripts and AI agents can recover the list without a separate `--list` flag:
205
205
206
206
```
207
-
error: vp create @acme requires a template selection in non-interactive mode.
207
+
error: vp create @your-org requires a template selection in non-interactive mode.
208
208
209
-
available templates from @acme/create:
209
+
available templates from @your-org/create:
210
210
211
211
NAME DESCRIPTION TEMPLATE
212
-
web Web app template (Vite + React) @acme/template-web
0 commit comments