Разработка виджета
После того как проект создан, можно приступать к написанию кода. Для удобства разработки используйте библиотеку @infomaximum/package-cli. Библиотека представляет собой интерфейс командной строки (CLI). С её помощью вы можете:
- создавать новые виджеты — генерировать начальные файлы и структуру проекта для нового виджета
- выполнять разработку виджета — в режиме разработки виджета используется функция HMR (Hot Module Replacement)
- выполнять сборку виджета — производить сборку пакета с вашим виджетом для последующей разработки или развертывания
В корне проекта был создан файл widgetrc.json, который является конфигурацией для библиотеки @infomaximum/package-cli. Подробнее о полях конфигурации можно узнать из документации к библиотеке.
Пример процесса разработки виджета
Разберем процесс разработки виджета после инициализации проекта на примере.
Чтобы разрабатывать виджет, необходимо выполнить сборку пакета с виджетом и загрузить его в систему через маркетплейс или напрямую в пространство. Для этого необходимо выполнить следующую команду:
yarn build:dev
Описанная выше команда является алиасом команды:
im-package-cli widget build --dev
где:
build
— подкоманда, которая указывает на то, что мы хотим выполнить сборку виджета--dev
— параметр указывает на то, что необходимо выполнить сборку пакета для дальнейшей разработки
Значения параметров host
и port
будут прописаны в манифесте собранного виджета и будут указывать браузеру, откуда запрашивать скрипт виджета.
В результате выполнения данной команды в директории, которая была указана в файле конфигурации widgetrc.json, будет создан архив (пакет) с именем пакета, указанным в файле манифеста пакета (package/manifest.json) с добавлением постфикса __DEV
и с расширением .zip. Загрузите полученный пакет в систему.
После загрузки пакета в систему необходимо запустить следующую команду:
yarn start
Данная команда является алиасом команды:
im-package-cli widget start
где:
start
— подкоманда, которая указывает на то, что мы хотим запустить dev-сервер для разработки виджета
После успешного выполнения этой команды вы сможете начать разработку вашего виджета и видеть в браузере результаты изменений исходного кода при использовании виджета.
Была ли статья полезна?