Ptnl-constructor-cli NPM

CLI инструменты при разработке виджеты

Инструмент работы в командной строке при разработке виджета.

Установка

Пакет ptnl-constructor-cli может быть установлен как глобально, так и в папку проекта:

# Глобальная установка
npm install -g ptnl-constructor-cli

# Проверим, что пакет успешно установлен
ptnl-constructor --help

# Создание папки проекта и установка локально
mkdir my-widget
cd my-widget
npm init -f
npm install ptnl-constructor-cli

# Проверим, что пакет успешно установлен
npx ptnl-constructor --help

Инициализация проекта

Если пакет установлен глобально, можно воспользоваться опцией --create

ptnl-constructor init --create /Users/user/my-widget
# допустимо --create my-widget
# допустимо --create ~/my-widget

Или создать папку и установить пакет локально:

mkdir my-widget
cd my-widget
npm init -f
npm install --save-dev ptnl-constructor-cli
npx ptnl-constructor init

Команда init установит необходимые зависимости и создаст базовую структуру проекта:

.
├── src
│   ├── config.ts
│   ├── my-widget.ts
│   └── view-settings.ts
├── widget
│   ├── config.json
│   ├── icon.svg
│   ├── index.html
│   └── style.css
├── .gitignore
├── .prettierrc.js
└── tsconfig.json

widget/config.json - этот файл нельзя изменять вручную; его содержимое генерируется
widget/icon.svg - стандартная иконка виджета; путь до нее указывается в файле конфигурации
widget/index.html - вариант html-файла; является входной точкой для отрисовки виджета
src/config.ts - файл конфигурации
src/my-widget.ts - файл виджета

Из этих исходников уже можно собрать виджет:

ptnl-constructor build

После сборки будет сформирован config.json и сгенерирован index.js в папке lib. В данном виде папку lib можно заархивировать и загружать в систему.