Fix Hardhat compile error when variable has whitespace before semicolon (#1020)

Co-authored-by: Hadrien Croubois <[email protected]>

Author: ericglau

packages/core/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.33.1 (2024-04-25)
+
+- Fix Hardhat compile error when variable has whitespace before semicolon. ([#1020](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1020))
+
 ## 1.33.0 (2024-04-24)
 
 - Enable changing default network files directory with environment variable. ([#1011](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1011))

packages/core/contracts/test/NamespacedToModify.sol

@@ -66,6 +66,13 @@ contract Example {
      * @dev a custom error inside a contract
      */
     error CustomErrorInsideContract(address a);
+
+    uint256 public spaceSemicolon ;
+    uint256 public twoSpacesSemicolon  ;
+    uint256 public tabSemicolon	;
+    uint256 public lineBreakSemicolon
+    ;
+    error SpaceSemicolon(uint256 a) ;
 }
 
 contract HasFunction {

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.33.0",
+  "version": "1.33.1",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",

packages/core/src/utils/make-namespaced.test.ts.md

@@ -90,6 +90,12 @@ Generated by [AVA](https://avajs.dev).
                * @dev a custom error inside a contract␊
                */␊
               enum $astId_id_random { dummy }␊
+          ␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
           }␊
           ␊
           contract HasFunction {␊

packages/core/src/utils/make-namespaced.test.ts.snap

@@ -178,9 +178,14 @@ function makeInsertAfter(node: Node, text: string): Modification {
 function makeDelete(node: Node, orig: Buffer): Modification {
   const positions = getPositions(node);
   let end = positions.end;
-  // If the next character is a semicolon for variables, skip over it
-  if (isNodeType('VariableDeclaration', node) && end + 1 < orig.length && orig.toString('utf8', end, end + 1) === ';') {
-    end += 1;
+  // For variables, skip past whitespaces and the first semicolon
+  if (isNodeType('VariableDeclaration', node)) {
+    while (end + 1 < orig.length && orig.toString('utf8', end, end + 1).trim() === '') {
+      end += 1;
+    }
+    if (end + 1 < orig.length && orig.toString('utf8', end, end + 1) === ';') {
+      end += 1;
+    }
   }
   return { start: positions.start, end };
 }