@weavix/cli 0.1.0-dev → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -51
- package/build/index.js +728 -1838
- package/build/templates/_shared/.arcignore +2 -1
- package/build/templates/_shared/manifest.schema.json +23 -11
- package/build/templates/_shared/package.json +10 -10
- package/build/templates/_shared/vite.config.ts +2 -0
- package/package.json +2 -2
- package/build/templates/issue.floatingbottom.action/index.html +0 -14
- package/build/templates/issue.floatingbottom.action/src/App.tsx +0 -28
package/README.md
CHANGED
|
@@ -1,29 +1,24 @@
|
|
|
1
1
|
# @weavix/cli
|
|
2
2
|
|
|
3
|
-
CLI-инструмент для
|
|
3
|
+
CLI-инструмент для локальной разработки плагинов: создание из шаблона, отладка, сборка, обновление шаблона. Публикация и регистрация плагинов выполняются отдельно — за пределами этого CLI.
|
|
4
4
|
|
|
5
5
|
## Установка
|
|
6
6
|
|
|
7
|
-
Установите пакет глобально:
|
|
8
|
-
|
|
9
7
|
```bash
|
|
10
8
|
npm install -g @weavix/cli
|
|
11
9
|
```
|
|
12
10
|
|
|
13
11
|
## Конфигурация
|
|
14
12
|
|
|
15
|
-
Перед первым использованием задайте параметры
|
|
13
|
+
Перед первым использованием задайте параметры окружения. Они нужны командам `build` и `debug` для генерации `config.json` и сборки бандла.
|
|
16
14
|
|
|
17
15
|
```bash
|
|
18
|
-
weavix config set
|
|
16
|
+
weavix config set # интерактивно задать значения
|
|
17
|
+
weavix config show # показать текущую конфигурацию
|
|
18
|
+
weavix config clear # удалить файл конфигурации
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
weavix config show # показать текущую конфигурацию
|
|
25
|
-
weavix config clear # удалить конфигурацию
|
|
26
|
-
```
|
|
21
|
+
Конфигурация хранится в `~/.tracker-cli/config.json`. URL Tracker'а захардкожен на `https://tracker.yandex.ru` и не настраивается; окружение всегда `production` (тестовой среды нет).
|
|
27
22
|
|
|
28
23
|
## Быстрый старт
|
|
29
24
|
|
|
@@ -33,62 +28,42 @@ weavix config clear # удалить конфигурацию
|
|
|
33
28
|
weavix create
|
|
34
29
|
```
|
|
35
30
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
- Выбрать шаблон
|
|
39
|
-
- Ввести данные плагина (название, описание и т.д.)
|
|
40
|
-
- Настроить структуру проекта
|
|
31
|
+
Запросит шаблон, имя/описание плагина и инициализирует папку проекта.
|
|
41
32
|
|
|
42
33
|
### 2. Отладка
|
|
43
34
|
|
|
44
|
-
Запустите локальный сервер разработки с hot reload:
|
|
45
|
-
|
|
46
35
|
```bash
|
|
47
|
-
weavix debug
|
|
36
|
+
weavix debug # с валидацией манифеста
|
|
37
|
+
weavix debug --no-lint # без валидации
|
|
48
38
|
```
|
|
49
39
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
### 3. Развертывание
|
|
40
|
+
Запускает локальный dev-сервер. Плагин ищите в слоте, указанном в `manifest.json`.
|
|
53
41
|
|
|
54
|
-
|
|
42
|
+
### 3. Сборка
|
|
55
43
|
|
|
56
44
|
```bash
|
|
57
|
-
weavix
|
|
45
|
+
weavix build
|
|
58
46
|
```
|
|
59
47
|
|
|
60
|
-
|
|
48
|
+
Собирает прод-бандл плагина в `dist/`.
|
|
61
49
|
|
|
62
|
-
|
|
50
|
+
### 4. Обновление шаблона
|
|
63
51
|
|
|
64
52
|
```bash
|
|
65
|
-
weavix
|
|
53
|
+
weavix up
|
|
66
54
|
```
|
|
67
55
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
### Конфигурация
|
|
71
|
-
|
|
72
|
-
- **`config set`** — задать параметры CLI (S3 endpoints, buckets, URL API)
|
|
73
|
-
- **`config show`** — показать текущую конфигурацию
|
|
74
|
-
- **`config clear`** — удалить конфигурацию
|
|
75
|
-
|
|
76
|
-
### Аутентификация
|
|
56
|
+
Подтягивает свежие файлы шаблона/конфигов в проект, сделанный из старой версии.
|
|
77
57
|
|
|
78
|
-
|
|
79
|
-
- **`logout`** — удалить сохранённые учётные данные
|
|
80
|
-
- **`whoami`** — показать текущего пользователя
|
|
81
|
-
|
|
82
|
-
### Разработка
|
|
83
|
-
|
|
84
|
-
- **`create`** — создать новый плагин из шаблона
|
|
85
|
-
- **`build`** — собрать плагин для продакшена
|
|
86
|
-
- **`lint`** — запустить TypeScript и ESLint
|
|
87
|
-
- **`debug`** — запустить локальный сервер разработки
|
|
88
|
-
- **`debug --no-lint`** — то же, без валидации манифеста
|
|
58
|
+
## Доступные команды
|
|
89
59
|
|
|
90
|
-
|
|
60
|
+
| Команда | Назначение |
|
|
61
|
+
|---|---|
|
|
62
|
+
| `create` | создать новый плагин из шаблона |
|
|
63
|
+
| `up` | обновить плагин до актуальной версии шаблона |
|
|
64
|
+
| `build` | собрать плагин для продакшена |
|
|
65
|
+
| `debug [--no-lint]` | локальный dev-сервер с hot reload |
|
|
66
|
+
| `lint` | TypeScript + ESLint |
|
|
67
|
+
| `config set\|show\|clear` | управление конфигурацией CLI |
|
|
91
68
|
|
|
92
|
-
|
|
93
|
-
- **`install`** — зарегистрировать плагин в конфиге окружения
|
|
94
|
-
- **`uninstall`** — удалить плагин из всех слотов
|
|
69
|
+
Команды публикации/регистрации/администрирования (`login`, `submit`, `install`, `deploy` и т. п.) во внешней сборке отсутствуют — они есть только во внутренней сборке `@yandex-data-ui/tracker-cli`.
|