Skip to content

Commit

Permalink
fixes, tests and initial py2 support (#2)
Browse files Browse the repository at this point in the history
Changes
* fixes bin path
* initial py2 support
* more unit tests
* basic cli tests
* refactoring code more testable
  • Loading branch information
Jussi Vatjus-Anttila authored Mar 5, 2019
1 parent be9bce9 commit 5498f7c
Show file tree
Hide file tree
Showing 12 changed files with 943 additions and 161 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,36 @@
[![CircleCI](https://circleci.com/gh/jupe/puml2code/tree/master.svg?style=svg)](https://circleci.com/gh/jupe/puml2code/tree/master)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![License badge](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io)


## PlantUML code generator (puml2code)

Tool that convert Plantuml -text file that represent UML diagram to code.
Tool that convert Plantuml -text file that represent class UML diagram to source code.

### Project status
**POC/IN PROGRESS**

- [ ] core implementation
- [x] core implementation
- [x] CLI interface
- [x] JS interface
- [x] ES6 output
- [ ] unit tests
- [ ] e2e tests
- [ ] documentation

### Installation

```
$ npm i -g puml2code
```

### Supported features
* output: file/console per class
* ES6 class
* imports based on parameter
* camelCase conversion
* private variables (with underscore prefix)
* methods with parameters
* code documentation
* output: file per class/console
* target language: es6 with code documentation
* imports based on parameter
* camelCase conversion
* private variables (with underscore prefix)
* methods with parameters

### Usage

Expand Down
3 changes: 3 additions & 0 deletions bin/puml2code
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env node

require('../src/cli')();
Loading

0 comments on commit 5498f7c

Please sign in to comment.