@emailmaker/extensions-sandbox 0.9.0-dev.3 → 0.9.0-dev.5
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 +58 -40
- package/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -901,71 +901,89 @@ settingsPanel.showSettingsPanel({
|
|
|
901
901
|
|
|
902
902
|
# 🧰 CLI
|
|
903
903
|
|
|
904
|
-
`@emailmaker/cli` — публичный генератор
|
|
904
|
+
`@emailmaker/cli` — публичный генератор проектов: внешние плагины и демо-стенды. Работает в интерактивном режиме и с полным набором аргументов командной строки.
|
|
905
905
|
|
|
906
|
-
##
|
|
906
|
+
## Флаги командной строки
|
|
907
907
|
|
|
908
|
-
|
|
909
|
-
- неинтерактивный запуск через аргументы командной строки
|
|
910
|
-
- генерация plugin-проекта
|
|
911
|
-
- генерация stand / stand-closed сценариев
|
|
912
|
-
- шаблоны под `vite` и `webpack`
|
|
913
|
-
- выбор target-а для внешнего плагина: `npm-пакет`, `встраиваемый bundle`, `advanced`
|
|
908
|
+
Ниже — опции, которые отражены в справке CLI (`--help`). Скрытые или служебные поля (монорепозиторий, отладка шаблонов) здесь не перечисляются.
|
|
914
909
|
|
|
915
|
-
|
|
910
|
+
### `--dev` / `--dev-packages`
|
|
916
911
|
|
|
917
|
-
|
|
912
|
+
**Самый частый флаг для разработки:** подставляет **dev**-версии внутренних npm-пакетов (`@emailmaker/*`), которые в шаблонах задаются с dist-tag `dev` вместо `latest`. Используйте, когда нужны свежие предрелизные сборки экосистемы.
|
|
913
|
+
|
|
914
|
+
```bash
|
|
915
|
+
npx @emailmaker/cli my-plugin --kind plugin --preset advanced --bundler vite --target npm-package --dev --output-dir ./my-plugin
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
Короткая форма: `--dev` (эквивалент `--dev-packages`).
|
|
919
|
+
|
|
920
|
+
### Остальные опции
|
|
921
|
+
|
|
922
|
+
| Флаг | Назначение |
|
|
923
|
+
|------|------------|
|
|
924
|
+
| `--interactive` | Запустить интерактивный мастер (шаги вместо обязательных аргументов). |
|
|
925
|
+
| `--package-name` | Явное имя npm-пакета для генерируемого плагина. |
|
|
926
|
+
| `--kind` | Режим: `plugin` или `demo-stand`. |
|
|
927
|
+
| `--stand-mode` | Сценарий стенда: `oauth`, `closed-loop`, `react-adapter`, `advanced` (и связанные варианты). |
|
|
928
|
+
| `--advanced-profile` | Для `--stand-mode advanced`: `subpath`, `shadow-dom`, `umd`. |
|
|
929
|
+
| `--preset` | Шаблон плагина: `minimal` или `advanced`. |
|
|
930
|
+
| `--bundler` | `vite` или `webpack` — сборщик в шаблоне. |
|
|
931
|
+
| `--target` | Поставка плагина: `npm-package`, `browser`, `advanced`. |
|
|
932
|
+
| `--advanced-target` | Доп. цель для режима `advanced` (только webpack), см. справку CLI. |
|
|
933
|
+
| `--app` | Идентификатор приложения (`REACT_APP_NAME`), как в монорепозитории; в опубликованном CLI может быть скрыт. |
|
|
934
|
+
| `--output-dir` | Каталог, куда положить сгенерированный проект. |
|
|
935
|
+
| `--output-base` | Базовый каталог: внутри него будет создана папка проекта. |
|
|
936
|
+
| `--force` | Разрешить запись в уже существующую директорию. |
|
|
918
937
|
|
|
919
|
-
|
|
938
|
+
Полный список и актуальные значения перечислены в выводе:
|
|
920
939
|
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
- базовой сборкой и scripts
|
|
940
|
+
```bash
|
|
941
|
+
npx @emailmaker/cli --help
|
|
942
|
+
```
|
|
925
943
|
|
|
926
|
-
|
|
944
|
+
## Что умеет CLI
|
|
927
945
|
|
|
928
|
-
|
|
946
|
+
- интерактивный wizard и неинтерактивный запуск;
|
|
947
|
+
- генерация проекта плагина и демо-стендов;
|
|
948
|
+
- шаблоны под **vite** и **webpack**;
|
|
949
|
+
- выбор способа поставки плагина: npm-модуль, браузерный бандл, режим **advanced**.
|
|
929
950
|
|
|
930
|
-
|
|
951
|
+
## Основные режимы
|
|
931
952
|
|
|
932
|
-
|
|
953
|
+
### `plugin`
|
|
933
954
|
|
|
934
|
-
|
|
955
|
+
Внешний плагин: app-часть, sandbox, локальный debug host, базовые скрипты сборки.
|
|
935
956
|
|
|
936
|
-
### `
|
|
957
|
+
### `demo-stand` (в т.ч. `stand`, `stand-closed` в документации)
|
|
937
958
|
|
|
938
|
-
|
|
959
|
+
Отдельный стенд для интеграции: варианты с OAuth, закрытым контуром, react-adapter, advanced-профили.
|
|
939
960
|
|
|
940
|
-
|
|
941
|
-
- базовая app/sandbox связка
|
|
942
|
-
- без React UI примера
|
|
961
|
+
## Preset-ы для `plugin`
|
|
943
962
|
|
|
944
|
-
|
|
963
|
+
- **`minimal`** — каркас без React-примера.
|
|
964
|
+
- **`advanced`** — React UI, `ComponentRegistry`, примеры панелей и API.
|
|
945
965
|
|
|
946
|
-
|
|
966
|
+
## Примеры
|
|
947
967
|
|
|
948
|
-
|
|
949
|
-
- `ComponentRegistry` из `@emailmaker/extensions-react`
|
|
950
|
-
- пример регистрации panel/icon
|
|
951
|
-
- пример `SettingsPanelApi` и `MessageService`
|
|
968
|
+
С **dev**-пакетами:
|
|
952
969
|
|
|
953
|
-
|
|
970
|
+
```bash
|
|
971
|
+
npx @emailmaker/cli my-plugin --kind plugin --preset advanced --bundler vite --target npm-package --dev --output-dir ./my-plugin
|
|
972
|
+
```
|
|
973
|
+
|
|
974
|
+
Без dev (стабильные версии из реестра):
|
|
954
975
|
|
|
955
976
|
```bash
|
|
956
|
-
npx @emailmaker/cli my-plugin --preset advanced --bundler vite --target npm-package --output-dir ./my-plugin
|
|
977
|
+
npx @emailmaker/cli my-plugin --kind plugin --preset advanced --bundler vite --target npm-package --output-dir ./my-plugin
|
|
957
978
|
```
|
|
958
979
|
|
|
959
|
-
После глобальной установки команда
|
|
980
|
+
После глобальной установки команда может называться `emailmaker-cli`.
|
|
960
981
|
|
|
961
982
|
## Когда использовать CLI
|
|
962
983
|
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
-
|
|
966
|
-
- не собирать вручную `vite`/`webpack` конфиг
|
|
967
|
-
- сразу получить готовую структуру проекта
|
|
968
|
-
- получить рабочий пример app, sandbox и локальной отладки
|
|
984
|
+
- быстро создать новый внешний плагин;
|
|
985
|
+
- не собирать вручную конфиг **vite** / **webpack**;
|
|
986
|
+
- получить согласованную структуру app, sandbox и локальной отладки.
|
|
969
987
|
|
|
970
988
|
|
|
971
989
|
---
|
package/index.js
CHANGED
|
@@ -60,7 +60,7 @@ var t = e("SandboxApp"), n = e("IframePluginRegistry");
|
|
|
60
60
|
n.packages[e.id] = e, n.validateAll();
|
|
61
61
|
}, t.__compat.registerPackage({
|
|
62
62
|
id: "extensions-sandbox",
|
|
63
|
-
version: "0.9.0-dev.
|
|
63
|
+
version: "0.9.0-dev.5",
|
|
64
64
|
requires: { host: "^1.0.105" }
|
|
65
65
|
});
|
|
66
66
|
}
|
package/package.json
CHANGED