sol2uml 2.1.8 → 2.1.9

package/README.md

@@ -97,6 +97,8 @@ Options:
   -hv, --hideVariables             hide variables from contracts, interfaces, structs and enums (default: false)
   -hf, --hideFunctions             hide functions from contracts, interfaces and libraries (default: false)
   -hp, --hidePrivates              hide private and internal attributes and operators (default: false)
+  -hm, --hideModifiers             hide modifier functions from contracts (default: false)
+  -ht, --hideEvents                hide events from contracts, interfaces and libraries (default: false)
   -hc, --hideConstants             hide file level constants (default: false)
   -he, --hideEnums                 hide enum types (default: false)
   -hs, --hideStructs               hide data structures (default: false)

package/lib/associations.d.ts

@@ -1,2 +1,2 @@
 import { Association, UmlClass } from './umlClass';
-export declare const findAssociatedClass: (association: Association, sourceUmlClass: UmlClass, umlClasses: UmlClass[]) => UmlClass | undefined;
+export declare const findAssociatedClass: (association: Association, sourceUmlClass: UmlClass, umlClasses: UmlClass[], searchedAbsolutePaths?: string[]) => UmlClass | undefined;

package/lib/associations.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.findAssociatedClass = void 0;
 const umlClass_1 = require("./umlClass");
 // Find the UML class linked to the association
-const findAssociatedClass = (association, sourceUmlClass, umlClasses) => {
+const findAssociatedClass = (association, sourceUmlClass, umlClasses, searchedAbsolutePaths = []) => {
     let umlClass = umlClasses.find((targetUmlClass) => {
         // is the source class link via the association to the target class?
         if (isAssociated(association, sourceUmlClass, targetUmlClass))
@@ -28,7 +28,9 @@ const findAssociatedClass = (association, sourceUmlClass, umlClasses) => {
     if (umlClass)
         return umlClass;
     // Could not find a link so now need to recursively look at imports of imports
-    return findImplicitImport(association, sourceUmlClass, umlClasses);
+    // add to already recursively processed files to avoid getting stuck in circular imports
+    searchedAbsolutePaths.push(sourceUmlClass.absolutePath);
+    return findImplicitImport(association, sourceUmlClass, umlClasses, searchedAbsolutePaths);
 };
 exports.findAssociatedClass = findAssociatedClass;
 // Tests if source class can be linked to the target class via an association
@@ -54,7 +56,7 @@ const isAssociated = (association, sourceUmlClass, targetUmlClass) => {
                     importedClass.alias &&
                     importedClass.className === targetUmlClass.name))));
 };
-const findImplicitImport = (association, sourceUmlClass, umlClasses) => {
+const findImplicitImport = (association, sourceUmlClass, umlClasses, searchedRelativePaths) => {
     // Get all implicit imports. That is, imports that do not explicitly import contracts or interfaces.
     const implicitImports = sourceUmlClass.imports.filter((i) => i.classNames.length === 0);
     // For each implicit import
@@ -65,8 +67,13 @@ const findImplicitImport = (association, sourceUmlClass, umlClasses) => {
             // Could not find a class in the import file so just move onto the next loop
             continue;
         }
+        // Avoid circular imports
+        if (searchedRelativePaths.includes(newSourceUmlClass.absolutePath)) {
+            // Have already recursively looked for imports of imports in this file
+            continue;
+        }
         // TODO need to handle imports that use aliases as the association will not be found
-        const umlClass = (0, exports.findAssociatedClass)(association, newSourceUmlClass, umlClasses);
+        const umlClass = (0, exports.findAssociatedClass)(association, newSourceUmlClass, umlClasses, searchedRelativePaths);
         if (umlClass)
             return umlClass;
     }

package/lib/converterClass2Dot.d.ts

@@ -3,6 +3,8 @@ export interface ClassOptions {
     hideConstants?: boolean;
     hideVariables?: boolean;
     hideFunctions?: boolean;
+    hideModifiers?: boolean;
+    hideEvents?: boolean;
     hideStructs?: boolean;
     hideEnums?: boolean;
     hideLibraries?: boolean;

package/lib/converterClass2Dot.js

@@ -62,7 +62,7 @@ const dotClassTitle = (umlClass, options = {}) => {
     }
     return `\\<\\<${stereoName}\\>\\>\\n${umlClass.name}${relativePath}`;
 };
-const dotAttributeVisibilities = (umlClass, options = {}) => {
+const dotAttributeVisibilities = (umlClass, options) => {
     if (umlClass.attributes.length === 0)
         return '';
     let dotString = '| ';
@@ -115,7 +115,7 @@ const dotAttributes = (attributes, vizGroup, indent = true) => {
     });
     return dotString;
 };
-const dotOperatorVisibilities = (umlClass, options = {}) => {
+const dotOperatorVisibilities = (umlClass, options) => {
     if (umlClass.operators.length === 0)
         return '';
     let dotString = '| ';
@@ -146,11 +146,11 @@ const dotOperatorVisibilities = (umlClass, options = {}) => {
                 operators.push(operator);
             }
         }
-        dotString += dotOperators(umlClass, vizGroup, operators);
+        dotString += dotOperators(umlClass, vizGroup, operators, options);
     }
     return dotString;
 };
-const dotOperators = (umlClass, vizGroup, operators) => {
+const dotOperators = (umlClass, vizGroup, operators, options) => {
     // Skip if there are no operators
     if (!operators || operators.length === 0) {
         return '';
@@ -160,7 +160,12 @@ const dotOperators = (umlClass, vizGroup, operators) => {
     const operatorsSortedByStereotype = operators.sort((a, b) => {
         return b.stereotype - a.stereotype;
     });
-    for (const operator of operatorsSortedByStereotype) {
+    // Filter out any modifiers or events if options are flagged to hide them
+    let operatorsFiltered = operatorsSortedByStereotype.filter((o) => !((options.hideModifiers === true &&
+        o.stereotype === umlClass_1.OperatorStereotype.Modifier) ||
+        (options.hideEvents === true &&
+            o.stereotype === umlClass_1.OperatorStereotype.Event)));
+    for (const operator of operatorsFiltered) {
         dotString += '\\ \\ \\ \\ ';
         if (operator.stereotype > 0) {
             dotString += dotOperatorStereotype(umlClass, operator.stereotype);

package/lib/parserFiles.js

@@ -48,7 +48,12 @@ function getSolidityFilesFromFolderOrFile(folderOrFilePath, ignoreFilesOrFolders
                     preserveSymlinks: true,
                 })
                     .on('data', (file) => {
-                    if ((0, path_1.extname)(file.path) === '.sol')
+                    if (
+                    // If file has sol extension
+                    (0, path_1.extname)(file.path) === '.sol' &&
+                        // and file and not a folder
+                        // Note Foundry's forge outputs folders with the same name as the source file
+                        file.stats.isFile())
                         files.push(file.path);
                 })
                     .on('end', () => {

package/lib/sol2uml.js

@@ -60,6 +60,8 @@ If an Ethereum address with a 0x prefix is passed, the verified source code from
     .option('-hv, --hideVariables', 'hide variables from contracts, interfaces, structs and enums', false)
     .option('-hf, --hideFunctions', 'hide functions from contracts, interfaces and libraries', false)
     .option('-hp, --hidePrivates', 'hide private and internal attributes and operators', false)
+    .option('-hm, --hideModifiers', 'hide modifier functions from contracts', false)
+    .option('-ht, --hideEvents', 'hide events from contracts, interfaces and libraries', false)
     .option('-hc, --hideConstants', 'hide file level constants', false)
     .option('-he, --hideEnums', 'hide enum types', false)
     .option('-hs, --hideStructs', 'hide data structures', false)

package/package.json

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