GitXplorerGitXplorer
r

diagres

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
6ecb18e658577ab99e0e0b9ac9ee6c8e6df3ce1d

Release v1.4.2.

rrhalff committed 9 years ago
Unverified
a44b13578146be5b2447045a117d33c37f2b2070

update

rrhalff committed 9 years ago
Unverified
0297dbe7dd5fdf2791940d51937d04ade3aeabe8

Release v1.4.1.

rrhalff committed 9 years ago
Unverified
b0a71daae651ff93bbd6485d510d76e90cd89192

fix prepublish

rrhalff committed 9 years ago
Unverified
4d6312ae224eda6edeab17610dcd5631161f81eb

Release v1.4.0.

rrhalff committed 9 years ago
Unverified
393eb46732e032a5b85200c546e228a4d2f8de00

update

rrhalff committed 9 years ago

README

The README file for this repository.

Diagres

Tool to generate class diagrams from es2015 code.

Example usage:

DEBUG=diagres diagres --pattern 'src/*.js' > test.puml

The parser itself is not aware of all es7 features, so if you want to parse those you'll first have to transpile the code and then point diagres at the transpile code.

e.g.

npm run your-build-process
DEBUG=diagres diagres --pattern 'dist/*.js' > test.puml

The parser looks for Class and Method Definitions, so make sure those have not been transpiled.

Example:

$ diagres -p 'git/teflon/src/**/*.js' > test.puml # a project
@startuml

class Events {
-_handleEvent(ev)
+addEventHandler(type, alias, action)
+off(event, listener)
+on(event, listener)
+removeEventHandler(type, alias, action)
+removeEventHandlers(type)
}
class Teflon {  
  
etc...

To convert to a e.g. a .png:

$ dot -Tpng -otest.png test.puml

Useful plantuml plugin for WebStorm:

https://github.com/esteinberg/plantuml4idea