plantuml-cli 1.2023.1

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,101 @@
+# Plantuml CLI
+
+[![NPM](https://img.shields.io/npm/v/plantuml-cli.svg?style=flat-square) ](https://www.npmjs.com/package/plantuml-cli)
+
+This is [Plantuml](https://github.com/plantuml/plantuml) wrapped [inside an NPM package](https://github.com/tomasbjerre/npm-java-runner). It relies only on dependencies found in NPM.
+
+See: https://github.com/plantuml/plantuml
+
+## Example - Command line
+
+It can be used as a command line tool like this:
+
+```bash
+npx plantuml-cli
+```
+
+## Command line arguments
+
+Available command line arguments `npx plantuml-cli -h`:
+
+```
+Usage: java -jar plantuml.jar [options] -gui
+  (to execute the GUI)
+    or java -jar plantuml.jar [options] [file/dir] [file/dir] [file/dir]
+  (to process files or directories)
+
+You can use the following wildcards in files/dirs:
+  *  means any characters but '/'
+  ?  one and only one character but '/'
+  **  means any characters (used to recurse through directories)
+
+where options include:
+    -darkmode    To use dark mode for diagrams
+    -gui    To run the graphical user interface
+    -tpng    To generate images using PNG format (default)
+    -tsvg    To generate images using SVG format
+    -teps    To generate images using EPS format
+    -tpdf    To generate images using PDF format
+    -tvdx    To generate images using VDX format
+    -txmi    To generate XMI file for class diagram
+    -tscxml    To generate SCXML file for state diagram
+    -thtml    To generate HTML file for class diagram
+    -ttxt    To generate images with ASCII art
+    -tutxt    To generate images with ASCII art using Unicode characters
+    -tlatex    To generate images using LaTeX/Tikz format
+    -tlatex:nopreamble  To generate images using LaTeX/Tikz format without preamble
+    -o[utput] "dir"  To generate images in the specified directory
+    -DVAR1=value  To set a preprocessing variable as if '!define VAR1 value' were used
+    -Sparam1=value  To set a skin parameter as if 'skinparam param1 value' were used
+    -Ppragma1=value  To set pragma as if '!pragma pragma1 value' were used
+    -I/path/to/file  To include file as if '!include file' were used
+    -I/path/to/*.puml  To include files with pattern
+    -theme xxx    To use a specific theme
+    -charset xxx  To use a specific charset (default is UTF-8)
+    -e[x]clude pattern  To exclude files that match the provided pattern
+    -metadata    To retrieve PlantUML sources from PNG images
+    -nometadata    To NOT export metadata in PNG/SVG generated files
+    -checkmetadata    Skip PNG files that don't need to be regenerated
+    -version    To display information about PlantUML and Java versions
+    -v[erbose]    To have log information
+    -quiet    To NOT print error message into the console
+    -debugsvek    To generate intermediate svek files
+    -h[elp]    To display this help message
+    -testdot    To test the installation of graphviz
+    -graphvizdot "exe"  To specify dot executable
+    -p[ipe]    To use stdin for PlantUML source and stdout for PNG/SVG/EPS generation
+    -encodesprite 4|8|16[z] "file"  To encode a sprite at gray level (z for compression) from an image
+    -computeurl|-encodeurl  To compute the encoded URL of a PlantUML source file
+    -decodeurl    To retrieve the PlantUML source from an encoded URL
+    -syntax    To report any syntax error from standard input without generating images
+    -language    To print the list of PlantUML keywords
+    -checkonly    To check the syntax of files without generating images
+    -failfast    To stop processing as soon as a syntax error in diagram occurs
+    -failfast2    To do a first syntax check before processing files, to fail even faster
+    -noerror    To skip images when error in diagrams
+    -duration    To print the duration of complete diagrams processing
+    -nbthread N    To use (N) threads for processing
+    -nbthread auto  To use 4 threads for processing
+    -timeout N    Processing timeout in (N) seconds. Defaults to 15 minutes (900 seconds).
+    -author[s]    To print information about PlantUML authors
+    -overwrite    To allow to overwrite read only files
+    -printfonts    To print fonts available on your system
+    -enablestats  To enable statistics computation
+    -disablestats  To disable statistics computation (default)
+    -htmlstats    To output general statistics in file plantuml-stats.html
+    -xmlstats    To output general statistics in file plantuml-stats.xml
+    -realtimestats  To generate statistics on the fly rather than at the end
+    -loopstats    To continuously print statistics about usage
+    -splash    To display a splash screen with some progress bar
+    -progress    To display a textual progress bar in console
+    -pipeimageindex N  To generate the Nth image with pipe option
+    -stdlib    To print standard library info
+    -extractstdlib  To extract PlantUML Standard Library into stdlib folder
+    -filedir xxx  To behave as if the PlantUML source is in this dir (only affects '-pipe' and PicoWeb 'POST /render')
+    -filename "example.puml"  To override %filename% variable
+    -preproc    To output preprocessor text of diagrams
+    -cypher    To cypher texts of diagrams so that you can share them
+    -picoweb    To start internal HTTP Server. See https://plantuml.com/picoweb
+
+If needed, you can setup the environment variable GRAPHVIZ_DOT.
+```

package/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('npm-java-runner/lib/index').run(__dirname);

package/package.json

@@ -0,0 +1,15 @@
+{
+  "version": "1.2023.1",
+  "name": "plantuml-cli",
+  "runnable-jar-regexp": "build/.*.jar",
+  "files": [
+    "build"
+  ],
+  "bin": "./index.js",
+  "dependencies": {
+    "npm-java-runner": "^1.0.2"
+  },
+  "license": "Apache 2",
+  "homepage": "https://github.com/tomasbjerre/plantuml-cli",
+  "repository": "git@github.com:tomasbjerre/plantuml-cli.git"
+}