https://github.com/hitode909/app-perlpackage2plantumlclassdiagram

Generates Plant UML's Class Diagram from Perl Modules
https://github.com/hitode909/app-perlpackage2plantumlclassdiagram

Last synced: 28 days ago
JSON representation

Generates Plant UML's Class Diagram from Perl Modules

• Host: GitHub
• URL: https://github.com/hitode909/app-perlpackage2plantumlclassdiagram
• Owner: hitode909
• License: other
• Created: 2015-10-12T09:30:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-02-15T05:20:45.000Z (almost 3 years ago)
• Last Synced: 2024-10-15T15:43:56.917Z (2 months ago)
• Language: Perl6
• Homepage:
• Size: 0 Bytes
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/hitode909/App-PerlPackage2PlantUMLClassDiagram.svg?branch=master)](https://travis-ci.org/hitode909/App-PerlPackage2PlantUMLClassDiagram)

# NAME

package2plantumlclassdiagram - Generates Plant UML's Class Diagram from Perl Modules

# DESCRIPTION

package2plantumlclassdiagram analyze Perl modules with PPI, and generate Plant UML's Class Diagram syntax.

You can render the output result with PlantUML.

[Output Example is here.](https://gist.github.com/hitode909/ce22c46004f2ff1dac73)

# SYNOPSIS

    % package2plantumlclassdiagram PATH_TO_MODULES > a.plantuml

Then, render a.plantuml with PlantUML.

    % GRAPHVIZ_DOT=$(which dot) plantuml -charset UTF-8 -tpng a.plantuml

    % open a.png

# PLOT ALL MODULES I YOUR PROJECT

Like this.

    % package2plantumlclassdiagram ~/YourApp/lib/**/**.pm > a.plantuml

# PLOT ONLY INHERITANCE RELATIONSHIPS

Use grep -P.

    % package2plantumlclassdiagram PATH_TO_MODULES | ggrep -P '^(@startuml|@enduml)|(<|--)' > a.plantuml

# SEE ALSO

[http://plantuml.com/classes.html](http://plantuml.com/classes.html)

# LICENSE

Copyright (C) hitode909.

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.

# AUTHOR

hitode909