feat: автообновление, шаблон zustand-store, документация
- Добавлено автоматическое обновление со спиннером (ora) - Новый шаблон zustand-store - Документация (FEATURES.md, LICENSE, README)
This commit is contained in:
29
README.md
29
README.md
@@ -2,23 +2,34 @@
|
||||
|
||||
CLI-утилита для генерации файлов из шаблонов.
|
||||
|
||||
## Установка
|
||||
|
||||
Глобально:
|
||||
|
||||
```bash
|
||||
npm i -g @gromlab/create
|
||||
```
|
||||
При запуске CLI проверяет доступность новой версии. Если вы выбираете «нет»,
|
||||
повторный запрос появится через 24 часа. Чтобы пропустить проверку, используйте
|
||||
флаг `--skip-update`.
|
||||
|
||||
|
||||
## Использование
|
||||
|
||||
```bash
|
||||
npx @gromlab/create <шаблон> <имя> [опции]
|
||||
npx @gromlab/create <шаблон> <имя> [путь] [опции]
|
||||
```
|
||||
|
||||
Если `[путь]` не указан, файлы создаются в директории, где запущен CLI.
|
||||
|
||||
## Пример
|
||||
|
||||
```bash
|
||||
# Создать компонент из шаблона
|
||||
npx @gromlab/create component Button
|
||||
|
||||
# Указать папку вывода
|
||||
npx @gromlab/create component Button --out src/components
|
||||
|
||||
# Превью без записи
|
||||
npx @gromlab/create component Button --dry-run
|
||||
# Указать папку вывода позиционно
|
||||
npx @gromlab/create component Button src/components
|
||||
```
|
||||
|
||||
## Шаблоны
|
||||
@@ -43,12 +54,12 @@ npx @gromlab/create component Button --dry-run
|
||||
- `{{name.kebab}}` — kebab-case
|
||||
- `{{name.snake}}` — snake_case
|
||||
|
||||
Переменная `name` задается только позиционным аргументом `<имя>`. Использование `--name` запрещено.
|
||||
|
||||
## Опции
|
||||
|
||||
| Опция | Описание |
|
||||
|-------|----------|
|
||||
| `--out <путь>` | Папка вывода (по умолчанию: `.`) |
|
||||
| `--templates <путь>` | Папка шаблонов (по умолчанию: `.templates`) |
|
||||
| `--overwrite` | Перезаписать существующие файлы |
|
||||
| `--dry-run` | Показать результат без записи |
|
||||
| `--skip-update` | Не проверять обновления CLI |
|
||||
| `--<переменная> <значение>` | Произвольная переменная шаблона |
|
||||
|
||||
Reference in New Issue
Block a user