@idem.agency/idem-ui 0.1.0 → 0.1.1
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
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# @idem.agency/idem-ui
|
|
2
|
+
|
|
3
|
+
Раздатчик готовых фронтенд-решений: CLI копирует исходники компонента из общего хранилища прямо в твой проект. Это не дизайн-система и не библиотека-зависимость — скопированный код становится твоим.
|
|
4
|
+
|
|
5
|
+
## Быстрый старт
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx -y @idem.agency/idem-ui web # визуальная витрина в браузере
|
|
9
|
+
npx -y @idem.agency/idem-ui get checkbox # забрать компонент по имени
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Нужны Node 22.16+ и доступ к `gitlab.idem.agency` (подними VPN — без него любая команда упадёт на «не удалось подключиться к хранилищу»).
|
|
13
|
+
|
|
14
|
+
Пользуешься часто — поставь глобально, дальше без `npx`:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm i -g @idem.agency/idem-ui
|
|
18
|
+
idem-ui web
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Что важно понимать
|
|
22
|
+
|
|
23
|
+
- **Компонент** — папка, решающая одну повторяющуюся задачу. Зовётся **слагом** — именем своей папки: `checkbox`, `burger`, `form`.
|
|
24
|
+
- **Вариант** — конкретная реализация внутри компонента (`next`). Вариант один — берётся молча, несколько — CLI спросит какой.
|
|
25
|
+
- **Copy-and-own.** После копирования файлы принадлежат проекту: правь как хочешь, связи с хранилищем не остаётся.
|
|
26
|
+
- **Зависимости ставишь сам.** CLI кладёт файлы и не трогает твой `package.json`. Что нужно доустановить — смотри в коде компонента и в его P.S.
|
|
27
|
+
- **Обновления нет.** «Обновить» = скопировать заново поверх с `--force`, потеряв свои правки в этой папке.
|
|
28
|
+
|
|
29
|
+
## Команды
|
|
30
|
+
|
|
31
|
+
### get — забрать компонент по имени
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
idem-ui get <slug> [--variant <label>] [--path <dir>] [--force]
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
| Флаг | Что делает |
|
|
38
|
+
| --- | --- |
|
|
39
|
+
| `--variant <label>` | взять конкретный вариант |
|
|
40
|
+
| `--path <dir>` | куда класть (по умолчанию — текущая папка) |
|
|
41
|
+
| `--force` | перезаписать существующую папку |
|
|
42
|
+
|
|
43
|
+
`--path` задаёт **родителя**: имя компонента дописывается всегда.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
idem-ui get checkbox --path src/shared/ui # → src/shared/ui/checkbox
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Папка уже занята — CLI спросит, перезаписывать ли (по умолчанию «нет»). Согласие или `--force` заменяет папку **целиком**: она сносится и пишется заново, твоих правок в ней не останется.
|
|
50
|
+
|
|
51
|
+
Из пайпа или CI спрашивать некого — там сразу передавай `--variant` (если вариантов несколько) и `--force` (если папка может быть занята), иначе команда упадёт.
|
|
52
|
+
|
|
53
|
+
После копирования CLI печатает описание компонента и, если автор его оставил, постскриптум под заголовком «P.S.» — читай, там бывает важное.
|
|
54
|
+
|
|
55
|
+
### list — витрина в терминале
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
idem-ui list
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Аргументов нет. В терминале с человеком — интерактивный список: набираешь часть слага или названия, список сужается; выбрал компонент — дальше тот же путь, что у `get` (спросит вариант, спросит папку, скопирует).
|
|
62
|
+
|
|
63
|
+
В пайпе или CI (`idem-ui list | grep form`) просто печатает перечень компонентов и выходит.
|
|
64
|
+
|
|
65
|
+
### web — витрина в браузере
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
idem-ui web
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Аргументов нет. Поднимает локальный сервер на `http://127.0.0.1:4321` (или ближайшем свободном порту) и сам открывает браузер. Там компоненты видны карточками с обложками, папку назначения выбираешь деревом своего проекта, копирование — кнопкой. `Ctrl+C` останавливает сервер.
|
|
72
|
+
|
|
73
|
+
Самый удобный вход, когда не знаешь, что вообще лежит в хранилище.
|
|
74
|
+
|
|
75
|
+
### help — справка
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
idem-ui # список команд
|
|
79
|
+
idem-ui help
|
|
80
|
+
idem-ui get --help # по конкретной команде
|
|
81
|
+
idem-ui help get
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
Актуальный список команд и флагов всегда отдаёт сам CLI: `idem-ui help`.
|