Dart Class Diagram Generator #
A small command line utility to generate a class (UML or similar) diagram from a Dart package.
Below is a UML diagram of the dcdg source code, created with dcdg. You can find the PlantUML source
Install from pub:
pub global activate dcdg
Install from clone:
pub global activate -s path .
From inside a Dart package repository:
pub global run dcdg
This will dump a PlantUML file to stdout. You can save it to a file instead with the
--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.
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.
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 automated
documentation and other resources. This script requires PlantUML.
1.0.0 - initial release
1.0.1 - fix bug where tool tried to parse non-Dart files
1.0.2 - improve readme
1.0.3 - add changelog and expand description
1.0.4 - fix bug where
--exported-only didn't work
1.0.5 - improve documentation
1.0.6 - export the necessary symbols
1.0.7 - add documentation comments
1.1.0 - add
1.2.0 - fix
1.3.0 - add aggregation, --exclude-has-a, --exclude-is-a
fix bug where exported classes were double-counted
1.3.1 - improve type name output
1.3.2 - widen dependency ranges for flutter users
2.0.0 - refactor to make builders simpler to implement
add nomnoml support
2.0.1 - fix incomplete --is-a implementation
Use this package as an executable
1. Install it
You can install the package from the command line:
$ pub global activate dcdg
2. Use it
The package has the following executables:
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: dcdg: ^2.0.1
2. Install it
You can install packages from the command line:
$ pub get
$ flutter pub get
Alternatively, your editor might support
pub get or
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Nov 8, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.6.0
- pana: 0.12.21
Detected platforms: Flutter, other
lib/src/diagram_visitor.dart. (-0.50 points)
lib/src/diagram_visitor.dart reported 1 hint:
line 275 col 16: 'isUndefined' is deprecated and shouldn't be used.
Maintenance issues and suggestions
Support latest dependencies. (-10 points)
The version constraint in
pubspec.yaml does not support the latest published versions for 1 dependency (
Maintain an example.
None of the files in the package's
example/ directory matches known example patterns.
Common filename patterns include
dcdg.dart. Packages with multiple examples should provide
For more information see the pub package layout conventions.
|Dart SDK||>=2.2.0 <3.0.0|