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

O que é?

Recursos principais

• 01Converte código-fonte JavaScript (ES6) em fluxogramas SVG no navegador ou no Node.js.
• 02Oferece uma CLI que gera um arquivo SVG a partir de um arquivo JS local.
• 03Inclui níveis de abstração predefinidos, como imports/exports, classes e dependências entre funções.
• 04Permite definir níveis de abstração personalizados e modificadores da árvore de fluxo.
• 05Inclui controles de foco, desfoque e remoção de blocos no gráfico.
• 06Oferece vários temas de cores e permite personalizar os estilos.

Casos de uso

• Documentar o funcionamento de um módulo ou função com um diagrama visual.
• Entender uma base de código desconhecida visualizando seu fluxo de controle passo a passo.
• Gerar slides de apresentação que vão da estrutura geral à lógica detalhada.
• Criar fluxogramas para um processo descrito com sintaxe JS válida.

Início rápido

1. 1

   Instale o pacote pelo NPM

   yarn add js2flowchart
2. 2

   Instale globalmente para usar a CLI em qualquer lugar

   yarn global add js2flowchart
3. 3

   Gere um fluxograma SVG a partir de um arquivo JS

   js2flowchart main.js

Antes de usar

• !A documentação informa que o suporte a vários arquivos é tratado por um projeto separado, o Codecrumbs, e não por esta biblioteca.
• !O último envio de código foi em outubro de 2023, então a manutenção pode ser lenta.
• !O README não descreve como o fluxograma é gerado para códigos além dos exemplos apresentados.

Tópicos

Perguntas frequentes

O que é js-code-to-svg-flowchart?

Biblioteca JavaScript e CLI que converte código JS em fluxogramas SVG, com níveis de abstração, modificadores de blocos de código e temas. js2flowchart analisa código JavaScript e o transforma em uma árvore sintática abstrata, monta a partir dela uma árvore de fluxo e renderiza essa árvore como um fluxograma SVG. A biblioteca funciona tanto no cliente quanto no servidor e oferece suporte à sintaxe ES6. É possível gerar o resultado pela API JavaScript ou pela linha de comando, passando um único arquivo como argumento.

js-code-to-svg-flowchart é gratuito? Qual é a licença?

js-code-to-svg-flowchart é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

js-code-to-svg-flowchart ainda é mantido?

Sem commits há mais de 6 meses. O último commit de js-code-to-svg-flowchart foi em 2 de out. de 2023.

Para que posso usar js-code-to-svg-flowchart?

Documentar o funcionamento de um módulo ou função com um diagrama visual. Entender uma base de código desconhecida visualizando seu fluxo de controle passo a passo. Gerar slides de apresentação que vão da estrutura geral à lógica detalhada. Criar fluxogramas para um processo descrito com sintaxe JS válida.

Como instalar js-code-to-svg-flowchart?

Instale o pacote pelo NPM: yarn add js2flowchart Instale globalmente para usar a CLI em qualquer lugar: yarn global add js2flowchart Gere um fluxograma SVG a partir de um arquivo JS: js2flowchart main.js

Onde consigo js-code-to-svg-flowchart?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart