sol2uml 2.1.5 → 2.1.6

package/README.md

@@ -77,9 +77,9 @@ Usage: sol2uml class <fileFolderAddress> [options]
 
 Generates UML diagrams from Solidity source code.
 
-If no file, folder or address is passes as the first argument, the working folder is used.
+If no file, folder or address is passed as the first argument, the working folder is used.
 When a folder is used, all *.sol files are found in that folder and all sub folders.
-A comma separated list of files and folders can also used. For example
+A comma separated list of files and folders can also be used. For example
     sol2uml contracts,node_modules/openzeppelin-solidity
 
 If an Ethereum address with a 0x prefix is passed, the verified source code from Etherscan will be used. For example

package/lib/converterAST2Classes.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertAST2UmlClasses = void 0;
 const path = __importStar(require("path"));
+const path_1 = require("path");
 const umlClass_1 = require("./umlClass");
 const typeGuards_1 = require("./typeGuards");
 const debug = require('debug')('sol2uml');
@@ -35,7 +36,6 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
     if (node.type === 'SourceUnit') {
         node.children.forEach((childNode) => {
             if (childNode.type === 'ContractDefinition') {
-                debug(`Adding contract ${childNode.name}`);
                 let umlClass = new umlClass_1.UmlClass({
                     name: childNode.name,
                     absolutePath: filesystem
@@ -44,6 +44,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                     relativePath,
                 });
                 umlClass = parseContractDefinition(umlClass, childNode);
+                debug(`Added contract ${childNode.name}`);
                 umlClasses.push(umlClass);
             }
             else if (childNode.type === 'StructDefinition') {
@@ -57,6 +58,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                     relativePath,
                 });
                 umlClass = parseStructDefinition(umlClass, childNode);
+                debug(`Added struct ${umlClass.name}`);
                 umlClasses.push(umlClass);
             }
             else if (childNode.type === 'EnumDefinition') {
@@ -69,6 +71,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                         : relativePath,
                     relativePath,
                 });
+                debug(`Added enum ${umlClass.name}`);
                 umlClass = parseEnumDefinition(umlClass, childNode);
                 umlClasses.push(umlClass);
             }
@@ -80,7 +83,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                         const importPath = require.resolve(childNode.path, {
                             paths: [codeFolder],
                         });
-                        imports.push({
+                        const newImport = {
                             absolutePath: importPath,
                             classNames: childNode.symbolAliases
                                 ? childNode.symbolAliases.map((alias) => {
@@ -90,7 +93,9 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                                     };
                                 })
                                 : [],
-                        });
+                        };
+                        debug(`Added filesystem import ${newImport.absolutePath} with class names ${newImport.classNames}`);
+                        imports.push(newImport);
                     }
                     catch (err) {
                         debug(`Failed to resolve import ${childNode.path} from file ${relativePath}`);
@@ -98,10 +103,12 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                 }
                 else {
                     // this has come from Etherscan
-                    const importPath = childNode.path[0] === '@'
-                        ? childNode.path
-                        : path.join(codeFolder, childNode.path);
-                    imports.push({
+                    const importPath = childNode.path[0] === '.'
+                        ? // Use Linux paths, not Windows paths, to resolve Etherscan files
+                            path_1.posix.join(codeFolder.toString(), childNode.path)
+                        : childNode.path;
+                    debug(`codeFolder ${codeFolder} childNode.path ${childNode.path}`);
+                    const newImport = {
                         absolutePath: importPath,
                         classNames: childNode.symbolAliases
                             ? childNode.symbolAliases.map((alias) => {
@@ -111,9 +118,12 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                                 };
                             })
                             : [],
-                    });
+                    };
+                    debug(`Added Etherscan import ${newImport.absolutePath} with class names: ${newImport.classNames}`);
+                    imports.push(newImport);
                 }
             }
+            // TODO add file level constants
         });
     }
     else {

package/lib/converterClasses2Storage.js

@@ -41,8 +41,9 @@ const convertClasses2Storages = (contractName, umlClasses, contractFilename) =>
             return name === contractName;
         }
         return (name === contractName &&
-            (relativePath == contractFilename ||
-                path_1.default.basename(relativePath) === contractFilename));
+            (relativePath == path_1.default.normalize(contractFilename) ||
+                path_1.default.basename(relativePath) ===
+                    path_1.default.normalize(contractFilename)));
     });
     if (!umlClass) {
         const contractFilenameError = contractFilename

package/lib/parserEtherscan.js

@@ -105,6 +105,7 @@ class EtherscanParser {
         const { files, contractName } = await this.getSourceCode(contractAddress);
         let umlClasses = [];
         for (const file of files) {
+            debug(`Parsing source file ${file.filename}`);
             const node = await this.parseSourceCode(file.code);
             const umlClass = (0, converterAST2Classes_1.convertAST2UmlClasses)(node, file.filename);
             umlClasses = umlClasses.concat(umlClass);

package/lib/sol2uml.js

@@ -46,9 +46,9 @@ program
 
 Generates UML diagrams from Solidity source code.
 
-If no file, folder or address is passes as the first argument, the working folder is used.
+If no file, folder or address is passed as the first argument, the working folder is used.
 When a folder is used, all *.sol files are found in that folder and all sub folders.
-A comma separated list of files and folders can also used. For example
+A comma separated list of files and folders can also be used. For example
     sol2uml contracts,node_modules/openzeppelin-solidity
 
 If an Ethereum address with a 0x prefix is passed, the verified source code from Etherscan will be used. For example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.1.5",
+  "version": "2.1.6",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",