Описание репозитория custom-chart

 

1 Введение

При помощи репозитория разработки плагинов custom-chart разработчики могут разработать и собрать дистрибутив плагина, пригодный для загрузки в административном интерфейсе ядра проекта.

Dev-сервер проекта включает в себя сборку ядра (в папке prebuild) и можно отлаживать плагин как будто он загружен на портал ядра.

2 Структура папок проекта

  • bin\ - внутренние скрипты для компиляции и запуска сервера;
  • build\ - папка для вывода результатов сборки;
  • config\ - внутренние скрипты для генерации конфига webpack;
  • docs\ - документация по проекту;
  • node_modules\;
  • prebuild\ - сборка ядра проекта в обфусцированном формате, используется для режима отладки;
  • server\ - основной код dev-сервера;
  • src\ - код проекта:
    • duplicates\ - дубликаты кода из ядра проекта, используются в зависимости от степени кастомизации, чтобы быстро получить работающий прототип;
    • managers\ - содержит упрощенный менеджер типов, позволяет управлять переключаться между дубликатами кода и собственными реализациями функционала плагина;
    • modules\ - модули встройки, разработка плагина в основном сводится в имплементации каждого из этих модулей;
    • index.js - точка входа при сборке.
  • babel.config.js - конфиг транспилера babel;
  • create-plugin.js - скрипт создания дистрибутива плагина;
  • multiply-plugin.js - служебный скрипт для генерации плагинов-заглушек под множество слотов;
  • package.json;
  • package-lock.json;
  • tsconfig.json;
  • ​​​​​​​webpack.config.js - конфиг вебпака.