Создание проекта

vp create интерактивно создаёт каркас новых проектов Vite+, монорепозиториев и приложений внутри существующих рабочих пространств.

Обзор

Команда create — это самый быстрый способ начать работу с Vite+. Её можно использовать несколькими способами:

Создать новый монорепозиторий Vite+
Создать новое отдельное приложение или библиотеку
Добавить новое приложение или библиотеку внутри существующего проекта

Эту команду можно использовать со встроенными шаблонами, шаблонами сообщества или удалёнными шаблонами с GitHub.

Использование

bash

vp create
vp create <template>
vp create <template> -- <template-options>

Встроенные шаблоны

Vite+ поставляется со следующими встроенными шаблонами:

vite:monorepo создаёт новый монорепозиторий
vite:application создаёт новое приложение
vite:library создаёт новую библиотеку
vite:generator создаёт новый генератор кода (только для монорепозиториев, см. раздел Генераторы кода)

Источники шаблонов

vp create не ограничен только встроенными шаблонами.

Используйте сокращённые шаблоны, такие как vite, @tanstack/start, svelte, next-app, nuxt, react-router и vue
Используйте полные имена пакетов, такие как create-vite или create-next-app
Используйте локальные шаблоны монорепозитория, объявленные в create.templates (например, внутренний генератор компонентов или сервисов)
Используйте удалённые шаблоны, такие как github:user/repo или https://github.com/user/template-repo

Выполните vp create --list, чтобы увидеть встроенные шаблоны и распространённые сокращённые шаблоны, которые распознаёт Vite+.

Параметры

--directory <dir> записывает сгенерированный проект в указанную целевую директорию
--agent <name> создаёт файлы с инструкциями для агента во время генерации проекта
--no-agent пропускает настройку инструкций для агента
--editor <name> записывает конфигурационные файлы редактора
--no-editor пропускает настройку конфигурации редактора
--git инициализирует git-репозиторий
--no-git пропускает инициализацию git-репозитория
--hooks включает настройку pre-commit хука
--no-hooks пропускает настройку хуков
--package-manager <name> использует указанный менеджер пакетов (pnpm, npm, yarn или bun)
--no-interactive запускает без запросов
--verbose показывает подробный вывод процесса генерации проекта
--list выводит список доступных встроенных и популярных шаблонов

Параметры шаблонов

Аргументы после -- передаются напрямую выбранному шаблону.

Это важно, когда сам шаблон принимает флаги. Например, вы можете передать выбор шаблона Vite следующим образом:

bash

vp create vite -- --template react-ts

Примеры

bash

# Интерактивный режим
vp create

# Создаём монорепозиторий, приложение, библиотеку или генератор Vite+
vp create vite:monorepo
vp create vite:application
vp create vite:library
vp create vite:generator

# Используем сокращённые шаблоны сообщества
vp create vite
vp create @tanstack/start
vp create svelte

# Используем полные имена пакетов
vp create create-vite
vp create create-next-app

# Используем удалённые шаблоны
vp create github:user/repo
vp create https://github.com/user/template-repo

Генераторы кода

В монорепозиториях часто возникает необходимость создавать собственные строительные блоки: UI-компоненты, сервисы или внутренние пакеты, соответствующие принятым в проекте соглашениям. Vite+ поддерживает это с помощью пакетов-генераторов на основе шаблонов Bingo.

Создание генератора

Внутри монорепозитория Vite+ выполните:

bash

vp create vite:generator

Для этого требуется рабочее пространство монорепозитория. Если его ещё нет, сначала создайте его с помощью vp create vite:monorepo.

Созданный пакет генератора содержит:

src/template.ts — определяет шаблон с помощью createTemplate из bingo: схему параметров, построенную на Zod, и функцию produce(), которая возвращает файлы для генерации
bin/index.ts — CLI-точку входа на основе runTemplateCLI из Bingo

Если в монорепозитории есть родительский каталог с именем generators или tools, новый пакет по умолчанию будет создан в нём.

Регистрация

Локальные генераторы объявляются в create.templates в файле vite.config.ts монорепозитория. Это основной источник истины: в списке выбора vp create отображаются только зарегистрированные шаблоны.

Команда vp create vite:generator регистрирует генератор автоматически, добавляя запись в create.templates корневого файла vite.config.ts:

import { defineConfig } from 'vite-plus';

export default defineConfig({
  create: {
    templates: [
      { name: 'my-generator', description: 'Generate new components', template: 'my-generator' },
    ],
  },
});

Повторный запуск идемпотентен (дублирующиеся записи не создаются), а существующее значение create.defaultTemplate сохраняется. Вы также можете добавлять записи вручную, например чтобы зарегистрировать шаблон, созданный другим способом. Значение template — это имя пакета генератора в рабочем пространстве или относительный путь к нему через ./path.

Запуск генератора

Внутри монорепозитория выполните vp create и выберите генератор из списка шаблонов либо передайте его имя из записи name напрямую:

bash

# В интерактивном режиме зарегистрированные локальные шаблоны
# отображаются вместе со встроенными
vp create

# Запуск зарегистрированного шаблона по его имени
vp create component

# Передача параметров генератору после --
vp create component -- --name @your-org/button

Если генератор зависит от bingo, Vite+ автоматически добавляет флаг --skip-requests, чтобы отключить исходящие сетевые запросы Bingo (например, обращения к API GitHub).

После выполнения генератора созданный пакет проходит стандартную интеграцию в монорепозиторий: регистрацию в рабочем пространстве, установку зависимостей и форматирование.

Настройка генератора

Отредактируйте src/template.ts, чтобы определить параметры и файлы, которые должен создавать генератор:

import { createTemplate } from 'bingo';
import { z } from 'zod';

export default createTemplate({
  options: {
    name: z.string().describe('Package name'),
  },
  async produce({ options }) {
    return {
      files: {
        'package.json': JSON.stringify({ name: options.name, version: '0.0.0' }, null, 2),
        src: {
          'index.ts': `export const name = '${options.name}';\n`,
        },
      },
    };
  },
});

options определяет параметры и вопросы генератора с помощью схем Zod
produce() возвращает файлы, которые нужно создать, а также необязательные скрипты для запуска после генерации и подсказки, которые будут показаны пользователю

Полное описание API шаблонов доступно в документации Bingo.

Шаблоны организации

Организация может публиковать курируемый набор шаблонов под общим организационным префиксом (@org), выпустив пакет @org/create, в package.json которого находится манифест createConfig.templates. После публикации команда vp create @org открывает интерактивный селектор из этих шаблонов.

Выбор из организации

bash

# Открываем интерактивный селектор по манифесту @your-org/create
vp create @your-org

# Запускаем конкретную запись из манифеста напрямую
vp create @your-org:web

# Указываем точную версию или dist-tag
vp create @your-org@1.2.3
vp create @your-org:web@next

# Создаём организацию шаблоном по умолчанию для репозитория (см. настройку create.defaultTemplate)
vp create

Под капотом команда vp create @org преобразуется в пакет @org/create (согласно существующему соглашению npm create-*). Если в этом пакете отсутствует поле createConfig.templates, Vite+ просто запускает пакет обычным способом. Поэтому добавление манифеста совершенно безопасно для организаций, которые уже публикуют @org/create.

Приватные реестры работают автоматически: Vite+ читает файлы .npmrc из корня проекта и домашней директории (~/), учитывая маппинги скоупов @your-org:registry=... и учётные данные //host/:_authToken=....

Создание пакета `@org/create`

Существует два распространённых подхода к структуре. Выберите тот, который лучше соответствует количеству шаблонов и частоте их обновления в вашей организации.

Всё в одном пакете (рекомендуется для большинства организаций). Все шаблоны находятся в подпапках самого пакета @org/create. В манифесте используются относительные пути ./path. Один репозиторий, одна публикация, одна история версионирования — тот же подход, который используют create-vite и create-next-app.

@your-org/create/
├── package.json              # "createConfig": { "templates": [{ "template": "./templates/web" }, ...] }
├── templates/
│   ├── web/
│   │   ├── package.json
│   │   └── src/...
│   └── library/...
└── README.md

Только манифест. Когда организация уже публикует независимые пакеты вида @org/template-* (или размещает их на GitHub), пакет @org/create остаётся тонким индексом (минимальным обёрточным пакетом).

@your-org/create/
├── package.json              # "createConfig": { "templates": [{ "template": "@your-org/template-web" }, ...] }
└── README.md

Два этих подхода можно комбинировать — манифест может указывать большинство записей на внешние пакеты, а несколько оставлять как встроенные подпапки.

По желанию можно добавить bin-скрипт, чтобы команда npm create @org (устаревший путь) продолжала работать для пользователей, не использующих Vite+. Команда vp create @org читает манифест напрямую и никогда не запускает bin-скрипт.

Схема манифеста

Манифест находится в поле createConfig.templates в файле package.json пакета @org/create:

json

{
  "name": "@your-org/create",
  "version": "1.0.0",
  "createConfig": {
    "templates": [
      {
        "name": "monorepo",
        "description": "Monorepo",
        "template": "@your-org/template-monorepo",
        "monorepo": true
      },
      {
        "name": "web",
        "description": "Web app template (Vite + React)",
        "template": "@your-org/template-web"
      },
      {
        "name": "demo",
        "description": "Bundled demo template",
        "template": "./templates/demo"
      }
    ]
  }
}

Каждая запись поддерживает следующие поля:

Поле	Обязательно	Примечания
`name`	да	Идентификатор в kebab-case. Используется в `vp create @org:<name>` для прямого выбора. Должен быть уникальным в пределах массива.
`description`	да	Однострочное описание, отображаемое в селекторе.
`template`	да	npm-спецификатор (`@org/template-foo`, опционально с `@version`), URL GitHub (`github:user/repo`), встроенный шаблон `vite:*`, имя пакета из локального workspace или относительный путь (`./templates/foo`), который разрешается относительно корня пакета `@org/create`.
`monorepo`	нет	Если `true`, помечает запись как шаблон для создания монорепозитория. Скрывается из селектора, когда `vp create` запускается внутри существующего монорепозитория (аналогично фильтру встроенного `vite:monorepo`).

Некорректный манифест — это жёсткая ошибка, а не тихий fallback. Сопровождающий, выпустивший манифест, должен узнать о проблемном поле (например: @your-org/create: createConfig.templates[2].template must be a non-empty string).

Шаблоны во вложенных подпапках

Относительные пути ./... разрешаются относительно корня пакета @org/create — не относительно текущей рабочей директории пользователя. Указанная директория копируется в целевой проект как есть (без обработки шаблонизатором). Единственное исключение — небольшое количество специальных файлов с префиксом подчёркивания (_gitignore, _npmrc, _yarnrc.yml), которые автоматически переименовываются в соответствующие dot-файлы. Пути, выходящие за пределы корня пакета, отклоняются.

Сделать организацию шаблоном по умолчанию в репозитории

Добавьте в vite.config.ts в корне проекта:

import { defineConfig } from 'vite-plus';

export default defineConfig({
  create: { defaultTemplate: '@your-org' },
});

Теперь vp create (без аргументов) сразу открывает селектор @your-org. Подробнее см. create.defaultTemplate.

Селектор всегда добавляет в конец пункт Встроенные шаблоны Vite+, чтобы шаблоны vite:monorepo / vite:application / vite:library / vite:generator оставались доступными из него. При выборе этого пункта происходит переход к стандартному встроенному потоку создания. Для скриптов и CI явные спецификаторы (vp create vite:library) обходят настроенный по умолчанию шаблон.

Проверка без интерактивного режима

Команда vp create @org --no-interactive выводит манифест в виде таблицы и завершается с кодом выхода 1:

A template name is required when running `vp create @your-org` in non-interactive mode.

Available templates in @your-org/create:

  NAME     DESCRIPTION                          TEMPLATE
  web      Web app template (Vite + React)      @your-org/template-web
  library  TypeScript library template          @your-org/template-library
  demo     Bundled demo template                ./templates/demo

Examples:
  # Scaffold a specific template from the org
  vp create @your-org:web --no-interactive

  # Or use a Vite+ built-in template
  vp create vite:application --no-interactive

Чек-лист публикации

Создайте пакет @org/create (npm-пакет с префиксом), если у вас его ещё нет.
Добавьте массив createConfig.templates в package.json. (Поместите шаблоны в ./templates/... или укажите ссылки на внешние пакеты.)
(Опционально) Добавьте bin-скрипт для совместимости с npm create @org.
Опубликуйте пакет.
Проверьте: vp create @org --no-interactive должен вывести таблицу манифеста; vp create @org должен открыть селектор.
(Опционально) Добавьте в ваши внутренние репозитории шаблонов настройку create: { defaultTemplate: '@org' }.

Создание проекта ​

Обзор ​

Использование ​

Встроенные шаблоны ​

Источники шаблонов ​

Параметры ​

Параметры шаблонов ​

Примеры ​

Генераторы кода ​

Создание генератора ​

Регистрация ​

Запуск генератора ​

Настройка генератора ​

Шаблоны организации ​

Выбор из организации ​

Создание пакета @org/create ​

Схема манифеста ​

Шаблоны во вложенных подпапках ​

Сделать организацию шаблоном по умолчанию в репозитории ​

Проверка без интерактивного режима ​

Чек-лист публикации ​

Создание проекта

Обзор

Использование

Встроенные шаблоны

Источники шаблонов

Параметры

Параметры шаблонов

Примеры

Генераторы кода

Создание генератора

Регистрация

Запуск генератора

Настройка генератора

Шаблоны организации

Выбор из организации

Создание пакета `@org/create`

Схема манифеста

Шаблоны во вложенных подпапках

Сделать организацию шаблоном по умолчанию в репозитории

Проверка без интерактивного режима

Чек-лист публикации