node package manager

scot4

Development environment of packages

scot4

Тулза помогающая разрабатывать пакеты: компоненты, утилиты и модули разного рода.

Использование

scot4 - является консольной утилитой, которая создана, чтобы автоматизировать рутиные процессы разработки пакетов. Вся работа осуществляется вызовом команды scot4 в консоле внутри рабочей директории (всегда является директорией репозитория).

Утилита имеет несколько команд, суть которых описана ниже:

Команда Аргументы Описание
dev [componentsPaths...] Запуск среды разработки
create [packageName] Мастер создания пакетов

Подробнее о командах

dev [componentsPaths...]

Команда запускает среду разработки компонент с предварительно выбранными целями, т.е. компонентами, над которыми требуется начать процесс разработки. Компоненты хранятся внутри папки packages, которая лежит в корне. Внутри каждой компоненты должна обязательна существовать папка stories с файлом-индексом, откуда проиходит рендеринг компонента (точка входа).

Документация по API историй находится тут: https://getstorybook.io/docs

Если не указывать компоненты, программа запустится в интерактивном режиме. Интерактивный режим позволяет видеть список всех доступных к разработке компонент и предлагает указать необходимые компоненты.

Команда игнорирует компоненты, которых не существует.

Установка

  1. Включи правильную версию Node.js nvm use
  2. Установите scot4 npm i scot4
  3. Создайте папку packages
  4. Попробуйте запустить команду scot4 в консоле, должна появиться справка

Расширение конфигурации среды разработки

Если это касается процесса разработки или компиляции документации, то редактировать необходимо файлы, связанные с StoryBook-окружением.

Настройка webpack: https://getstorybook.io/docs/configurations/custom-webpack-config

Настройка babel: https://getstorybook.io/docs/configurations/custom-babel-config

Содействие

Поговорите с Димой: @sukazavr