@jeff-tian/tplant
Typescript to PlantUML
Last updated 5 months ago by jeff-tian .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @jeff-tian/tplant 
SYNC missed versions from official npm registry.

tplant

Typescript to UML (PlantUML)

Will convert a Typescript file to UML diagram. Following all inheritances.

Build Status codecov Build status Git commit with emojis!

Quality gate

Usage

Install

npm install --global @jeff-tian/tplant

Generate image file (svg or png)

tplant --input test/Playground/**/*.ts --output test/Playground/Playground.svg
tplant --input test/Playground/Classes/Greeter.ts --output test/Playground/Classes/Greeter.png

Internet connection is required

Generate puml file

tplant --input test/Playground/**/*.ts --output test/Playground/Playground.puml
tplant --input test/Playground/Classes/Greeter.ts --output test/Playground/Classes/Greeter.puml

Options

-i, --input <path>

Define the path of the Typescript file

-o, --output <path>

Define the path of the output file. If not defined, it'll output on the STDOUT

-p, --project <path>

Compile a project given a valid configuration file.
The argument can be a file path to a valid JSON configuration file, or a directory path to a directory containing a tsconfig.json file.

-C, --compositions

Create not heritage compositions.
Example:
class Wheel {
  public size: number;
}
class Car {
  public wheel: Wheel;
}
@startuml
class Wheel {
    +size: number
}
class Car {
    +wheel: Wheel
}
Car *-- Wheel
@enduml

-I, --only-interfaces

Only convert interfaces

References

https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API

Current Tags

  • 2.4.6                                ...           latest (5 months ago)

9 Versions

  • 2.4.6                                ...           5 months ago
  • 2.4.5                                ...           5 months ago
  • 2.4.4                                ...           5 months ago
  • 2.4.3                                ...           5 months ago
  • 2.4.2                                ...           6 months ago
  • 2.4.1                                ...           6 months ago
  • 2.4.0                                ...           6 months ago
  • 2.3.19                                ...           6 months ago
  • 2.3.18                                ...           6 months ago
Maintainers (1)
Downloads
Today 1
This Week 1
This Month 1
Last Day 0
Last Week 9
Last Month 10
Dependencies (4)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |