Added depthLimit option to restrict recursive searching of sub folder

Fixed output files when no outputFileName is used Made writing the svg file async Catch all errors thrown and output to console Bumped version
soulchef14 · Aug 16, 2019 · 5586bad · 5586bad
1 parent d1c206d
commit 5586bad
Show file tree

Hide file tree

Showing 15 changed files with 109 additions and 198 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,7 @@ $ sol2uml -h
     -v, --verbose                 run with debugging statements
     -f, --outputFormat <value>    output file format: svg, png, dot or all (default: "svg")
     -o, --outputFileName <value>  output file name
+    -d, --depthLimit <depth>      number of sub folders that will be recursively searched for Solidity files. Default -1 is unlimited (default: -1)
     -n, --network <network>       mainnet, ropsten, kovan, rinkeby or goerli (default: "mainnet")
     -k, --etherscanApiKey <key>   Etherscan API Key
     -c, --clusterFolders          Cluster contracts into source folders
@@ -122,4 +123,4 @@ This is a rewrite of the Richard Ramos's [solidity-diagram-gen](https://github.c
 
 This version uses the [solidity-parser-antlr](https://github.com/federicobond/solidity-parser-antlr) Solidity parser which is built on top of [ANTLR4 grammar](https://github.com/solidityj/solidity-antlr4). The logic to generate the dot syntax has been rewritten and different UML syntax is now used.
 
-The diagrams are generated using [viz.js](https://github.com/mdaines/viz.js/) which uses [Graphviz](http://www.graphviz.org/) to render a [Scalable Vector Graphics (SVG)](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) file. [Graphviz Online](https://dreampuf.github.io/GraphvizOnline/) allows dot files to be edited and rendered into a SVN dynamically.
+The diagrams are generated using [viz.js](https://github.com/mdaines/viz.js/) which uses [Graphviz](http://www.graphviz.org/) to render a [Scalable Vector Graphics (SVG)](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) file. [Graphviz Online](https://dreampuf.github.io/GraphvizOnline/) allows dot files to be edited and rendered into a SVG dynamically.
diff --git a/lib/converter.d.ts b/lib/converter.d.ts
@@ -5,5 +5,5 @@ export declare function convertUmlClasses2Dot(umlClasses: UmlClass[], clusterFol
 export declare function addAssociationsToDot(umlClasses: UmlClass[]): string;
 export declare function convertDot2Svg(dot: string): any;
 export declare function writeDot(dot: string, dotFilename?: string): void;
-export declare function writeSVG(svg: any, svgFilename?: string, outputFormats?: OutputFormats): void;
-export declare function writePng(svg: any, pngFilename?: string): Promise<void>;
+export declare function writeSVG(svg: any, svgFilename?: string, outputFormats?: OutputFormats): Promise<void>;
+export declare function writePng(svg: any, filename: string): Promise<void>;
diff --git a/lib/converter.js b/lib/converter.js
diff --git a/lib/etherscan.d.ts b/lib/etherscan.d.ts
diff --git a/lib/etherscan.js b/lib/etherscan.js
diff --git a/lib/fileParser.d.ts b/lib/fileParser.d.ts
@@ -1,6 +1,6 @@
 import { ASTNode } from 'solidity-parser-antlr';
 import { UmlClass } from './umlClass';
-export declare const parseUmlClassesFromFiles: (fileOrFolders: string[]) => Promise<UmlClass[]>;
-export declare function getSolidityFilesFromFolderOrFiles(folderOrFilePaths: string[]): Promise<string[]>;
-export declare function getSolidityFilesFromFolderOrFile(folderOrFilePath: string): Promise<string[]>;
+export declare const parseUmlClassesFromFiles: (fileOrFolders: string[], depthLimit?: number) => Promise<UmlClass[]>;
+export declare function getSolidityFilesFromFolderOrFiles(folderOrFilePaths: string[], depthLimit?: number): Promise<string[]>;
+export declare function getSolidityFilesFromFolderOrFile(folderOrFilePath: string, depthLimit?: number): Promise<string[]>;
 export declare function parseSolidityFile(fileName: string): ASTNode;
diff --git a/lib/fileParser.js b/lib/fileParser.js
diff --git a/lib/sol2uml.js b/lib/sol2uml.js
diff --git a/lib/solidityFileParser.d.ts b/lib/solidityFileParser.d.ts
diff --git a/lib/solidityFileParser.js b/lib/solidityFileParser.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Unified Modeling Language (UML) class diagram generator for Solidity contracts",
   "main": "./lib/sol2uml.js",
   "types": "./lib/sol2uml.d.ts",