Bogdan-Lyashenko/js-code-to-svg-flowchart

Что это?

Ключевые возможности

• 01Преобразует исходный код JavaScript (ES6) в блок-схемы SVG в браузере или Node.js.
• 02Предоставляет CLI для создания SVG-файла из локального JS-файла.
• 03Предлагает предустановленные уровни абстракции, например импорты и экспорты, классы и зависимости функций.
• 04Позволяет задавать собственные уровни абстракции и модификаторы дерева потока выполнения.
• 05Включает инструменты focus, blur и сворачивания блоков диаграммы.
• 06Предлагает несколько цветовых тем и поддерживает пользовательские стили.

Сценарии использования

• Документирование работы модуля или функции с помощью наглядной диаграммы.
• Изучение незнакомой кодовой базы с пошаговым просмотром потока выполнения.
• Создание презентационных слайдов, переходящих от общей структуры к подробной логике.
• Построение блок-схем процессов, описанных с помощью корректного синтаксиса JS.

Быстрый старт

1. 1

   Установите пакет из NPM

   yarn add js2flowchart
2. 2

   Установите пакет глобально, чтобы использовать CLI откуда угодно

   yarn global add js2flowchart
3. 3

   Создайте SVG-блок-схему из JS-файла

   js2flowchart main.js

Что важно знать

• !В документации указано, что поддержку нескольких файлов обеспечивает отдельный проект Codecrumbs, а не эта библиотека.
• !Последняя отправка кода была в октябре 2023 года, поэтому обновления могут выходить редко.
• !В README не описано, как будет выглядеть блок-схема для кода, отличного от примеров.

Темы

Частые вопросы

Что такое js-code-to-svg-flowchart?

Библиотека JavaScript и CLI для преобразования исходного кода JS в блок-схемы SVG с уровнями абстракции, модификаторами блоков кода и темами оформления. js2flowchart разбирает код JavaScript в абстрактное синтаксическое дерево, строит на его основе дерево потока выполнения и отображает его в виде блок-схемы SVG. Библиотека работает как на клиенте, так и на сервере и поддерживает синтаксис ES6. Результат можно сгенерировать через JavaScript API или из командной строки, передав путь к одному файлу.

js-code-to-svg-flowchart можно использовать бесплатно? Какая у него лицензия?

js-code-to-svg-flowchart распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

js-code-to-svg-flowchart всё ещё поддерживается?

Нет коммитов больше 6 месяцев. Последний коммит в js-code-to-svg-flowchart — 2 окт. 2023 г..

Для чего можно использовать js-code-to-svg-flowchart?

Документирование работы модуля или функции с помощью наглядной диаграммы. Изучение незнакомой кодовой базы с пошаговым просмотром потока выполнения. Создание презентационных слайдов, переходящих от общей структуры к подробной логике. Построение блок-схем процессов, описанных с помощью корректного синтаксиса JS.

Как установить js-code-to-svg-flowchart?

Установите пакет из NPM: yarn add js2flowchart Установите пакет глобально, чтобы использовать CLI откуда угодно: yarn global add js2flowchart Создайте SVG-блок-схему из JS-файла: js2flowchart main.js

Где скачать js-code-to-svg-flowchart?

Исходный код и инструкции по установке — на GitHub: https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart