From e76e7ce76e384c9e03f1db0cd4ae0c81a6f1bdba Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Wed, 9 Sep 2020 15:56:58 +0800 Subject: [PATCH 1/7] Update plantuml.1.2020.16.jar Bump version from http://sourceforge.net/projects/plantuml/files/plantuml.1.2020.16.jar/download --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index de2e6da..5bf1597 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "node-plantuml", - "version": "0.9.0", - "plantumlVersion": "1.2019.6", + "version": "0.9.1", + "plantumlVersion": "1.2020.16", "description": "A Node.js module and CLI for running PlantUML", "main": "index.js", "author": "Markus Hedvall ", From 50b187ca5d8ec45f4cad6f72002249dd49d96f45 Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Wed, 30 Sep 2020 19:20:21 +0800 Subject: [PATCH 2/7] Update plantuml.1.2020.17.jar Bump version from http://sourceforge.net/projects/plantuml/files/plantuml.1.2020.17.jar/download --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5bf1597..c89ac53 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "node-plantuml", "version": "0.9.1", - "plantumlVersion": "1.2020.16", + "plantumlVersion": "1.2020.17", "description": "A Node.js module and CLI for running PlantUML", "main": "index.js", "author": "Markus Hedvall ", From 001bec07113f0e08f96621101b146a49df1a07b4 Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Thu, 15 Oct 2020 13:30:03 +0800 Subject: [PATCH 3/7] Update plantuml.1.2020.19.jar Bump version from http://sourceforge.net/projects/plantuml/files/plantuml.1.2020.19.jar/download --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c89ac53..69d89c1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "node-plantuml", "version": "0.9.1", - "plantumlVersion": "1.2020.17", + "plantumlVersion": "1.2020.19", "description": "A Node.js module and CLI for running PlantUML", "main": "index.js", "author": "Markus Hedvall ", From 14e0c7a98a32c4030431ad314c0e717df4d6e894 Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Fri, 30 Oct 2020 05:23:33 +0800 Subject: [PATCH 4/7] README.md: fix broken images and format Signed-off-by: Huang Rui --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index dc68527..01b4054 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,19 @@ This module also provides an easy to use and flexible command line interface for Install [Graphviz](http://www.graphviz.org/) to be able to generate all diagram types. -# Install +## Install -``` +```shell npm install node-plantuml ``` If you want to use the CLI node-plantuml can be install it globally: -``` +```shell npm install node-plantuml -g ``` -# Example +## Example Diagrams can be created from source files. @@ -69,19 +69,22 @@ app.get('/svg/:uml', function(req, res) { app.listen(8080); ``` -# CLI +## CLI The node-plantuml CLI can be accessed with the puml command. + ```shell puml generate file.puml -o file.png ``` It's also possible to use stdin and stdout for input and output. + ```shell puml decode UDfpLD2rKt0200GS0Iy0 | puml generate > file.png ``` Simple textual one-liners can also be used as input. + ```shell puml generate --unicode --text "A -> B: Hello" ┌─┐ ┌─┐ @@ -95,7 +98,8 @@ puml generate --unicode --text "A -> B: Hello" ``` There are multiple options for input and for output. And the output can be in multiple different formats. -``` + +```text Usage: puml [options] [command] @@ -112,7 +116,7 @@ Options: -V, --version output the version number ``` -``` +```text Usage: generate [options] [file] Generate an UML diagram from PlantUML source @@ -133,7 +137,7 @@ Options: -C, --charset [charset] specify the charset of PlantUML source ``` -``` +```text Usage: encode [options] [file] Encodes PlantUML source @@ -144,7 +148,7 @@ Options: -t, --text [text] UML text to encode ``` -``` +```text Usage: decode [options] Decodes PlantUML source @@ -154,13 +158,14 @@ Options: -h, --help output usage information ``` -# Config templates +## Config templates With predefined configuration templates the looks of the diagrams can be altered. For a more classic black and white look the classic configuration template can be used. -![alt tag](http://www.plantuml.com/plantuml/img/UDgjb3rFmp0GXdV_YjjeGK7C3AWV0qAg0Ab2B2oESqcFkdOvErIbyDznqxfVILi6rhl7zxxlsKd7USc-d6WXBkxH84iDpiyrcKAuCPcfP3a1DvAPdOKQv58x52FA41InqYXsC6CzzgGQ5snBa_MjjWol8_9uo5ZEa5VzdWu7WdXVI-SW8rbKWZKBqu39ukpuYDKKjeXQAdMzPqfBZm_AcY5z8TmS8h0G0Crw05rcEzkT7z2Qva_8DSIF4et24z5SH1RDWv_33P6YgJI-hh7VFk9sG3aEo62pnHSNBbEwKnPBXnNn7ojPBVSfTSYVoDN8g-Mpe7pUQc-1lZMAqMC4ktycUqV9OPc-e_BhlbtpmPyELRAcAZCMv3no7DUANBjgb-OCi9ADJRVIhwT9ak-xpHP4FSD-Fpg_J99jKJo6ZmbIwxsTWCrZlDkw1NWpa8TBY4w1J4Fyy0gqtjIlD_iJ7JJPyX_n2m4TUEG0) +![alt tag](http://www.plantuml.com/plantuml/img/~1UDgjb3rFmp0GXdV_YjjeGK7C3AWV0qAg0Ab2B2oESqcFkdOvErIbyDznqxfVILi6rhl7zxxlsKd7USc-d6WXBkxH84iDpiyrcKAuCPcfP3a1DvAPdOKQv58x52FA41InqYXsC6CzzgGQ5snBa_MjjWol8_9uo5ZEa5VzdWu7WdXVI-SW8rbKWZKBqu39ukpuYDKKjeXQAdMzPqfBZm_AcY5z8TmS8h0G0Crw05rcEzkT7z2Qva_8DSIF4et24z5SH1RDWv_33P6YgJI-hh7VFk9sG3aEo62pnHSNBbEwKnPBXnNn7ojPBVSfTSYVoDN8g-Mpe7pUQc-1lZMAqMC4ktycUqV9OPc-e_BhlbtpmPyELRAcAZCMv3no7DUANBjgb-OCi9ADJRVIhwT9ak-xpHP4FSD-Fpg_J99jKJo6ZmbIwxsTWCrZlDkw1NWpa8TBY4w1J4Fyy0gqtjIlD_iJ7JJPyX_n2m4TUEG0) Compared to the standard PlantUML look: -![alt tag](http://www.plantuml.com/plantuml/img/UDgDaJ4EmZ0CHVUSmcCB2WTWG8NkCB2ofC55GMai9IuI0kuEj4qGAWZM_vzYFwS8h3otZHL2MnK2RAg0_eGUBW9W2exOrESi5xS8bEIqHyO8BlycLr_9RLiTKVFGqy2NPEqZDUIwsEF114OVdyiYbtTrwtu0_TXOXdx-s4RAwo9TGOmTtlku-KJALoZMn0WLCLC3L4Uz-NW5s3ceoITbCEw3FcXbRSfdwNwYGBT__jqTLUUSCW00) +![alt tag](http://www.plantuml.com/plantuml/img/~1UDgDaJ4EmZ0CHVUSmcCB2WTWG8NkCB2ofC55GMai9IuI0kuEj4qGAWZM_vzYFwS8h3otZHL2MnK2RAg0_eGUBW9W2exOrESi5xS8bEIqHyO8BlycLr_9RLiTKVFGqy2NPEqZDUIwsEF114OVdyiYbtTrwtu0_TXOXdx-s4RAwo9TGOmTtlku-KJALoZMn0WLCLC3L4Uz-NW5s3ceoITbCEw3FcXbRSfdwNwYGBT__jqTLUUSCW00) + +## License -# License MIT From f2d5b7c0e8c4d91e6ee72681b29531c8d5b5b32d Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Fri, 30 Oct 2020 05:59:21 +0800 Subject: [PATCH 5/7] package.json: fix strange CI build problem, resolve dependent If have no plantuml installed, the graphviz always failed to find. Test graphviz dependent on the plantuml installation. Signed-off-by: Huang Rui --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 69d89c1..0aab38b 100644 --- a/package.json +++ b/package.json @@ -37,8 +37,9 @@ "scripts/get-vizjs.js" ], "scripts": { - "prepublish": "node scripts/get-plantuml-jar.js", - "postinstall": "node scripts/get-vizjs.js", + "getpuml": "node scripts/get-plantuml-jar.js", + "prepublish": "npm run getpuml", + "postinstall": "npm run getpuml && node scripts/get-vizjs.js", "test": "standard && node test/fixtures/prepare.js && mocha", "build": "node nail/build.js" }, From 9f23f02c0cbb64eebe6b3b452e848a2de370209f Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Fri, 30 Oct 2020 06:19:42 +0800 Subject: [PATCH 6/7] package.json: add missing file scripts/get-plantuml-jar.js Signed-off-by: Huang Rui --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index 0aab38b..e2f9ea6 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "resources/", "nail/plantumlnail.jar", "scripts/download.js", + "scripts/get-plantuml-jar.js", "scripts/get-vizjs.js" ], "scripts": { From ebc2943f773ef6d6563dd92fe33899537216c27f Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Fri, 30 Oct 2020 06:22:06 +0800 Subject: [PATCH 7/7] .travis.yml: change node to lts version Signed-off-by: Huang Rui --- .travis.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index fc3b8dc..fb00aeb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,5 @@ language: node_js node_js: - - "6" - - "8" - "10" - - "node" + - "12" + - "lts/*"