feat: display function modifiers in class diagrams

naddison36 · Sep 2, 2022 · 34f7267 · 34f7267
1 parent 2d17d84
commit 34f7267
Show file tree

Hide file tree

Showing 10 changed files with 743 additions and 750 deletions.
diff --git a/examples/polygonMusd.svg b/examples/polygonMusd.svg
diff --git a/lib/converterAST2Classes.js b/lib/converterAST2Classes.js
diff --git a/lib/converterClass2Dot.js b/lib/converterClass2Dot.js
diff --git a/lib/umlClass.d.ts b/lib/umlClass.d.ts
@@ -53,6 +53,7 @@ export interface Operator extends Attribute {
     parameters?: Parameter[];
     returnParameters?: Parameter[];
     isPayable?: boolean;
+    modifiers?: string[];
 }
 export declare enum ReferenceType {
     Memory = 0,

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": "2.1.9",
+  "version": "2.2.0",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

diff --git a/src/contracts/SomeImpl.sol b/src/contracts/SomeImpl.sol
@@ -73,6 +73,12 @@ contract SomeImpl is SomeInterface {
             _;
         }
 
+    function withModifier() someModifier(true) {
+    }
+
+    function withTwoModifiers(uint256 someInt) someModifier(true) modifierMultiParams(false, someInt) {
+    }
+
     function add(uint256 someNumber) public returns (uint256) {
         somePublicNumber = somePublicNumber + someNumber;
         return somePublicNumber;

diff --git a/src/ts/converterAST2Classes.ts b/src/ts/converterAST2Classes.ts
@@ -320,6 +320,7 @@ function parseContractDefinition(
                     stereotype,
                     parameters: parseParameters(subNode.parameters),
                     returnParameters: parseParameters(subNode.returnParameters),
+                    modifiers: subNode.modifiers.map((m) => m.name),
                 })
             }
 

diff --git a/src/ts/converterClass2Dot.ts b/src/ts/converterClass2Dot.ts
@@ -278,6 +278,10 @@ const dotOperators = (
             dotString += ': ' + dotParameters(operator.returnParameters, true)
         }
 
+        if (options.hideModifiers === false && operator.modifiers?.length > 0) {
+            dotString += ` \\<\\<${operator.modifiers.join(', ')}\\>\\>`
+        }
+
         dotString += '\\l'
     }
 

diff --git a/src/ts/umlClass.ts b/src/ts/umlClass.ts
@@ -62,6 +62,7 @@ export interface Operator extends Attribute {
     parameters?: Parameter[]
     returnParameters?: Parameter[]
     isPayable?: boolean
+    modifiers?: string[]
 }
 
 export enum ReferenceType {