#diagram #uml #parser #dot #generator #source #generate

bin+lib rudg

Rust UML Diagram Generator. A library for generating UML diagram from Rust source code.

2 releases

0.1.1 May 20, 2022
0.1.0 May 15, 2022

#5 in #uml

23 downloads per month

MIT/Apache

39KB
906 lines

rudg

Rust UML Diagram Generator

Tools that parsing Rust code into UML diagram (in dot format currently).

License License: MIT

Usage

$ rudg.exe --help
rudg 0.1.0

USAGE:
    rudg.exe [file] [OPTIONS]

ARGS:
    <file>    Rust source code file path

OPTIONS:
    -h, --help            Print help information
    -o, --output <DIR>    Sets a custom output directory
    -V, --version         Print version information

Roadmap (TODO list)

  • comprehensive tests and bug fix
  • support for modelling the whole crate's source code

Contributing

  • All sorts of contributing are welcome. Please feel free to open issue and/or PR.
  • We belive that TDD(Test-Driven Development) approach is helpful not only in development, but also in communication with each other. So adding more tests might be a good way to report a bug or even suggest a new feature.

License

rudg is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

dot_graph: A library for generating Graphviz DOT language files.

Dependencies

~5–13MB
~164K SLoC