Buscar pacotes, repositórios e categorias de apps

Capa de dcdg
Detalhes do pacotev4.1.0

dcdg

Uma ferramenta para gerar automaticamente diagramas de classes (como UML) a partir de um pacote Dart.

AndroidiOSmacOSWindowsLinux
Downloads em 30 dias
444
Curtidas
179
Pontos Pub
120

Instalar pacote

flutter pub add dcdg

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

dcdg é uma ferramenta de desenvolvedor que gera automaticamente diagramas de classes, como UML, a partir de pacotes Dart. Ele analisa a estrutura do código Dart para visualizar classes, suas relações e hierarquias de herança, ajudando na compreensão de bases de código complexas. Ideal para documentação, onboarding ou revisão de design, suporta múltiplas plataformas, incluindo Android, iOS, macOS, Windows e Linux. A ferramenta se integra por meio do Flutter pub e é de código aberto, hospedada no GitHub.

Casos de uso

  • Documentação da base de código
  • Onboarding de novos desenvolvedores
  • Visualização de design
  • Planejamento de refatoração
  • Documentação técnica

Principais recursos

  • Geração automática de diagrama UML
  • Suporta projetos multiplataforma
  • Open-source e extensível
  • Integração com o Flutter pub
  • Visualiza relações de classe

Indicado para

  • desenvolvedores Dart
  • Documentação da equipe
  • Grandes bases de código
  • Arquitetos de software
  • Fins educacionais

Considerações

  • Requer análise de código Dart
  • A qualidade da saída depende da estrutura do código
  • Atualizações não em tempo real
  • Opções limitadas de personalização
  • Melhor para análise estática

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

Build Status

Dart Class Diagram Generator

A small command line utility to generate a class (UML or similar) diagram from a Dart package.

Examples

Below is a UML diagram of the dcdg source code, created with dcdg. You can find the PlantUML source in the example/ directory.

Example UML Diagram

Installation

Install from pub:

dart pub global activate dcdg

Install from clone:

dart pub global activate -s path .

Usage

From inside a Dart package directory:

dart pub global run dcdg

This will dump a PlantUML file to stdout. You can save it to a file instead with the -o option.

If you'd like to create a Mermaid file instead, pass the -b option with mermaid as its argument:

dart pub global run dcdg -b mermaid

See --help for more options, including ways to filter what ends up in the output. You can find the help contents in USAGE.txt as well.

Examples

There are test fixtures in test/fixtures/. Each Dart package in this directory contains various (fake) classes. Try running DCDG against these fixtures to familiarize yourself with how it works.

Contributing

Pull requests are welcome! It is intended to be reasonably straightforward to add a new output format. Take a look at the DOT format implementation in lib/src/builders for an example.

If you have found a bug or have a feature request please open an issue.

Development

Format code using the tool/format.sh script. It will have a non-zero exit code if the formatting changed. That's fine, it does that so it can be used in CI.

Run the full test suite (including unit and functional tests) with tool/check.sh.

If you change the user interface or add features you should run tool/docs.sh to regenerate documentation and other resources. This script requires PlantUML.

Categorias

Dependências

Lista de dependências 3 itens

Repositório-fonte

Projetos que usam este pacote

Ainda não há dados.