В рамках дизайн-системы Koobiq предоставляется набор схематиков — CLI-инструментов, предназначенных для автоматизации установки библиотеки, выполнения миграций и обновления компонентов в Angular-проектах.
Устанавливает библиотеку @koobiq/components и добавляет все необходимые зависимости.
Когда использовать: при первом подключении библиотеки в проект.
ng add @koobiq/componentsОбновляет префиксы и имена иконок, необходимых для перехода с версии 7.2.x и ниже до версии 8.0.2 и выше.
Когда использовать: после обновления версии библиотеки @koobiq/icons до версии 8.0.2 и выше.
ng generate @koobiq/components:new-icons-packОбновляет устаревшие CSS-селекторы (именования типографики и цветов) в соответствии с новыми соглашениями дизайн-системы.
Когда использовать: после обновления версии библиотеки @koobiq/components до версии 18.6.0 и выше.
ng generate @koobiq/components:css-selectorsПереводит иконки с устаревшего шрифта pt-icons на kbq и переименовывает устаревшие иконки.
Когда использовать: пока в проекте остаются классы pt-icons (class="pt-icons pt-icons-<name>").
ng generate @koobiq/components:deprecated-iconsОбновляет названия и значения атрибутов размеров в местах использования компонента Empty state как в HTML, так и в TypeScript шаблонах.
Когда использовать: после обновления версии библиотеки @koobiq/components до версии 18.22.0 и выше.
ng generate @koobiq/components:empty-state-size-attrОбновляет названия и значения атрибутов размеров в местах использования компонента Overlay как в HTML, так и в TypeScript шаблонах.
Когда использовать: после обновления версии библиотеки @koobiq/components до версии 18.22.0 и выше.
ng generate @koobiq/components:loader-overlay-size-attrЗаменяет названия иконок на новые
Когда использовать: после обновления версии библиотеки @koobiq/icons до версии 11.0.0 и выше.
ng generate @koobiq/components:icons-replacementng update не запускает иконочные схематики: запустите подходящие проекту сами, в этом порядке. icons-replacement переименовывает имена, которые выдают два других, поэтому он идёт последним.
| Порядок | Схематик | Запускать, если в проекте есть |
|---|---|---|
| 1 | new-icons-pack | @koobiq/icons ниже 8.0.2: префикс mc (mc-<name>, kbq-icon="mc-<name>") |
| 2 | deprecated-icons | классы pt-icons (class="pt-icons pt-icons-<name>") |
| 3 | icons-replacement | @koobiq/icons ниже 11.0.0 |
Без --fix=true каждый из них только сообщает о найденном, и каждый пишет в лог, на каком наборе соответствий иконок работает. Общие параметры:
--project — имя проекта или папка, например ./libs; без него мигрируется весь workspace. node_modules и dist пропускаются всегда.--custom-data-path (new-icons-pack, icons-replacement) — JSON-файл со своим набором соответствий, путь от корня workspace: [{ "replace": "kbq-add-to-list_16", "replaceWith": "kbq-file-plus-o_16" }]. Без него используется встроенный.ng generate @koobiq/components:new-icons-pack --project ./libs
ng generate @koobiq/components:new-icons-pack --project ./libs --fix=trueng versionng generate:ng generate "@koobiq/components:<имя-схематика>"schema.json внутри соответствующего схематика.