Implement the generation of image files via www.plantuml.com/plantuml (…

…#38)

* * Implement the generation of image files via www.plantuml.com/plantuml
* Fix Namespace bug for an empty body

* * Use fs.createWriteStream to download the image

README.md

@@ -1,12 +1,25 @@
 # tplant
-Typescript to PlantUML
+Typescript to UML (PlantUML)
 
-Will convert a Typescript file to a PlantUML file. Following all inheritances.
+Will convert a Typescript file to UML diagram. Following all inheritances.
 
 ## Usage
 
-```
+### Install
+```shell
 npm install --global tplant
+```
+
+### Generate image file (svg or png)
+```shell
+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
+```shell
+tplant --input test/Playground/**/*.ts --output test/Playground/Playground.puml
 tplant --input test/Playground/Classes/Greeter.ts --output test/Playground/Classes/Greeter.puml
 ```
 
@@ -45,7 +58,7 @@ Car *-- Wheel
 @enduml
 ```
 ### -I, --only-interfaces
-    Only output interfaces
+    Only convert interfaces
 
 # References
 https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API

package.json

@@ -1,12 +1,14 @@
 {
   "name": "tplant",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Typescript to PlantUML",
   "keywords": [
-    "Class Diagram",
+    "class diagram",
+    "uml diagram",
     "plantuml",
     "typescript",
-    "uml"
+    "uml",
+    "cli"
   ],
   "homepage": "https://github.com/bafolts/tplant#readme",
   "bugs": {
@@ -41,6 +43,7 @@
   "dependencies": {
     "commander": "^2.20.0",
     "glob": "^7.1.3",
+    "plantuml-encoder": "^1.2.5",
     "typescript": "^3.4.5"
   },
   "devDependencies": {

src/@types/plantuml-encoder/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+
+declare module 'plantuml-encoder' {
+    export function encode(text: string): string;
+  }

src/Components/Namespace.ts

@@ -16,21 +16,14 @@ export class Namespace implements IComponentComposite {
 
     public toPUML(): string {
         const result: string[] = [];
-        const declaration: string[] = [];
-        declaration.push(`namespace ${this.name}`);
-        if (this.parts.length > 0) {
-            declaration.push(' {');
-        }
-        result.push(declaration.join(''));
+        result.push(`namespace ${this.name} {`);
         this.parts.forEach((part: IComponentComposite): void => {
             result.push(
                 part.toPUML()
                     .replace(/^(?!\s*$)/gm, '    ')
             );
         });
-        if (this.parts.length > 0) {
-            result.push('}');
-        }
+        result.push('}');
 
         return result.join(os.EOL);
     }

src/index.ts

@@ -5,13 +5,17 @@
 import commander from 'commander';
 import fs from 'fs';
 import G from 'glob';
+import http from 'http';
 import os from 'os';
 import path from 'path';
+import { encode } from 'plantuml-encoder';
 import ts from 'typescript';
 import { tplant } from './tplant';
 
+const AVAILABLE_PLANTUML_EXTENSIONS: string[] = ['svg', 'png', 'txt'];
+
 commander
-    .version('2.2.1')
+    .version('2.3.0')
     .option('-i, --input <path>', 'Define the path of the Typescript file')
     .option('-o, --output <path>', 'Define the path of the output file. If not defined, it\'ll output on the STDOUT')
     .option(
@@ -31,14 +35,12 @@ if (!commander.input) {
 
 G(<string>commander.input, {}, (err: Error | null, matches: string[]): void => {
     if (err !== null) {
-        console.error(err);
-
-        return;
+        throw err;
     }
 
     const tsConfigFile: string | undefined = findTsConfigFile(<string>commander.input, <string | undefined>commander.tsconfig);
 
-    const output: string = tplant.convertToPlant(
+    const plantUMLDocument: string = tplant.convertToPlant(
         tplant.generateDocumentation(matches, getCompilerOptions(tsConfigFile)),
         {
             compositions: <boolean>commander.compositions,
@@ -47,21 +49,22 @@ G(<string>commander.input, {}, (err: Error | null, matches: string[]): void => {
     );
 
     if (commander.output === undefined) {
-        console.log(output);
+        console.log(plantUMLDocument);
 
         return;
     }
 
-    // tslint:disable-next-line non-literal-fs-path
-    fs.writeFile(<string>commander.output, output, (errNoException: NodeJS.ErrnoException | null): void => {
-        if (errNoException !== null) {
-            console.error(errNoException);
+    const extension: string = path.extname(<string>commander.output)
+        .replace(/^\./gm, '');
 
-            return;
-        }
+    if (AVAILABLE_PLANTUML_EXTENSIONS.includes(extension)) {
+        requestImageFile(<string>commander.output, plantUMLDocument, extension);
 
-        console.log('The file was saved!');
-    });
+        return;
+    }
+
+    // tslint:disable-next-line non-literal-fs-path
+    fs.writeFileSync(<string>commander.output, plantUMLDocument, 'binary');
 });
 
 function findTsConfigFile(inputPath: string, tsConfigPath?: string): string | undefined {
@@ -129,3 +132,18 @@ function getCompilerOptions(tsConfigFilePath?: string): ts.CompilerOptions {
 
     return convertedCompilerOptions.options;
 }
+
+function requestImageFile(output: string, input: string, extension: string): void {
+    http.get({
+        host: 'www.plantuml.com',
+        path: `/plantuml/${extension}/${encode(input)}`
+    },       (res: http.IncomingMessage): void => {
+        // tslint:disable-next-line non-literal-fs-path
+        const fileStream: fs.WriteStream = fs.createWriteStream(output);
+        res.setEncoding('binary');
+        res.pipe(fileStream);
+        res.on('error', (err: Error): void => {
+            throw err;
+        });
+    });
+}