make state-variable-immutable override imply state-variable-assignment too

Author: frangio

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.3.25 (2023-07-05)
+
+- Allow immutable variable assignment given `unsafe-allow state-variable-immutable`. Previously `unsafe-allow state-variable-assignment` was required as well.
+
 ## 0.3.24 (2023-05-04)
 
 - Allow constructor override at contract level.

contracts/TransformAllowedImmutable.sol

@@ -3,14 +3,14 @@ pragma solidity ^0.8.2;
 
 contract T1 {
     uint immutable a = 1;
-    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
+    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     uint immutable b = 4;
     uint immutable c = 3;
 }
 
 contract T2 {
     uint immutable a = 1;
-    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
+    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     uint immutable b = 4;
     uint immutable c;
     /// @custom:oz-upgrades-unsafe-allow constructor

contracts/TransformCustomSize.sol

@@ -13,9 +13,9 @@ struct OneAndAHalfSlot {
 }
 
 contract SizeDefault {
-  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
+  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
   uint immutable w1 = block.number;
-  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
+  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
   uint immutable w2 = block.timestamp;
   uint immutable x; // slot 0 (after conversion to private)
   uint constant y = 1;
@@ -43,9 +43,9 @@ contract SizeDefault {
 
 /// @custom:storage-size 128
 contract SizeOverride {
-  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
+  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
   uint immutable w1 = block.number;
-  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable  state-variable-assignment
+  /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
   uint immutable w2 = block.timestamp;
   uint immutable x; // slot 0 (after conversion to private)
   uint constant y = 1;

src/transform-0.8.test.ts.md

@@ -87,14 +87,14 @@ Generated by [AVA](https://avajs.dev).
             c = 3;␊
         }␊
         uint a;␊
-        /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment␊
+        /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
         uint immutable b = 4;␊
         uint c;␊
     }␊
     ␊
     contract T2 {␊
         uint a = 1;␊
-        /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment␊
+        /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
         uint immutable b = 4;␊
         uint c;␊
         /// @custom:oz-upgrades-unsafe-allow constructor␊
@@ -131,9 +131,9 @@ Generated by [AVA](https://avajs.dev).
     }␊
     ␊
     contract SizeDefault {␊
-      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment␊
+      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
       uint immutable w1 = block.number;␊
-      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment␊
+      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
       uint immutable w2 = block.timestamp;␊
       uint x; // slot 0 (after conversion to private)␊
       uint constant y = 1;␊
@@ -177,9 +177,9 @@ Generated by [AVA](https://avajs.dev).
     ␊
     /// @custom:storage-size 128␊
     contract SizeOverride {␊
-      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment␊
+      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
       uint immutable w1 = block.number;␊
-      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable  state-variable-assignment␊
+      /// @custom:oz-upgrades-unsafe-allow state-variable-immutable␊
       uint immutable w2 = block.timestamp;␊
       uint x; // slot 0 (after conversion to private)␊
       uint constant y = 1;␊

src/transform-0.8.test.ts.snap

@@ -23,7 +23,14 @@ export function hasOverride(
   override: ValidationErrorKind,
   resolver: ASTResolver,
 ): boolean {
-  return getOverrides(node, resolver).includes(override);
+  const overrides = getOverrides(node, resolver);
+  return (
+    overrides.includes(override) ||
+    (override === 'state-variable-assignment' &&
+      node.nodeType === 'VariableDeclaration' &&
+      node.mutability === 'immutable' &&
+      overrides.includes('state-variable-immutable'))
+  );
 }
 
 export function getOverrides(node: Node, resolver: ASTResolver): ValidationErrorKind[] {