Fix rename-inheritdoc with peer project (#133)

Author: Amxx

contracts/project/SomeContract.sol

@@ -15,18 +15,27 @@ struct SomeStruct {
     uint member;
 }
 
-contract SomeContract is ISomeContract {
+contract SomeBaseContract {
+    function test(ISomeInterface other) public virtual returns (bool) {
+        return SomeLibrary.bothFunctions(other);
+    }
+}
+
+contract SomeContract is ISomeContract, SomeBaseContract {
     SomeStruct s;
 
+    /// @inheritdoc ISomeInterface
     function someFunction() public pure override returns (bool) {
         return false;
     }
 
+    /// @inheritdoc ISomeInterface
     function someOtherFunction() public pure override returns (bool) {
         return true;
     }
 
-    function test(ISomeInterface other) public returns (bool) {
-        return SomeLibrary.bothFunctions(this) && SomeLibrary.bothFunctions(other);
+    /// @inheritdoc SomeBaseContract
+    function test(ISomeInterface other) public override returns (bool) {
+        return SomeLibrary.bothFunctions(this) && super.test(other);
     }
 }

src/prepare-peer-project.test.ts.md

@@ -1,6 +1,6 @@
-# Snapshot report for `src/partial-transform.test.ts`
+# Snapshot report for `src/prepare-peer-project.test.ts`
 
-The actual snapshot is saved in `partial-transform.test.ts.snap`.
+The actual snapshot is saved in `prepare-peer-project.test.ts.snap`.
 
 Generated by [AVA](https://avajs.dev).
 
@@ -27,24 +27,45 @@ Generated by [AVA](https://avajs.dev).
       ␊
       import { SomeStruct } from "@openzeppelin/contracts/project/SomeContract.sol";␊
       ␊
-      contract SomeContractUpgradeable is Initializable, ISomeContract {␊
+      contract SomeBaseContractUpgradeable is Initializable {␊
+          function __SomeBaseContract_init() internal onlyInitializing {␊
+          }␊
+      ␊
+          function __SomeBaseContract_init_unchained() internal onlyInitializing {␊
+          }␊
+          function test(ISomeInterface other) public virtual returns (bool) {␊
+              return SomeLibrary.bothFunctions(other);␊
+          }␊
+      ␊
+          /**␊
+           * @dev This empty reserved space is put in place to allow future versions to add new␊
+           * variables without shifting down storage in the inheritance chain.␊
+           * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps␊
+           */␊
+          uint256[50] private __gap;␊
+      }␊
+      ␊
+      contract SomeContractUpgradeable is Initializable, ISomeContract, SomeBaseContractUpgradeable {␊
           SomeStruct s;␊
       ␊
           function __SomeContract_init() internal onlyInitializing {␊
           }␊
       ␊
           function __SomeContract_init_unchained() internal onlyInitializing {␊
           }␊
+          /// @inheritdoc ISomeInterface␊
           function someFunction() public pure override returns (bool) {␊
               return false;␊
           }␊
       ␊
+          /// @inheritdoc ISomeInterface␊
           function someOtherFunction() public pure override returns (bool) {␊
               return true;␊
           }␊
       ␊
-          function test(ISomeInterface other) public returns (bool) {␊
-              return SomeLibrary.bothFunctions(this) && SomeLibrary.bothFunctions(other);␊
+          /// @inheritdoc SomeBaseContractUpgradeable␊
+          function test(ISomeInterface other) public override returns (bool) {␊
+              return SomeLibrary.bothFunctions(this) && super.test(other);␊
           }␊
       ␊
           /**␊

src/prepare-peer-project.test.ts.snap

@@ -9,20 +9,29 @@ import { matchBuffer } from '../utils/match';
 
 export function* renameInheritdoc(
   sourceUnit: SourceUnit,
-  { readOriginal }: TransformerTools,
+  { readOriginal, getData, resolver }: TransformerTools,
 ): Generator<Transformation> {
-  for (const doc of findAll('StructuredDocumentation', sourceUnit)) {
-    const bounds = getNodeBounds(doc);
-    const re = /(@inheritdoc\s+)([a-zA-Z0-9$_]+)/;
-    const match = matchBuffer(readOriginal(doc, 'buffer'), re);
+  for (const contract of findAll('ContractDefinition', sourceUnit)) {
+    const baseContracts = contract.linearizedBaseContracts.map(i => resolver.resolveContract(i));
 
-    if (match) {
-      yield {
-        start: bounds.start + match.start + match.captureLengths[0],
-        length: match.captureLengths[1],
-        kind: 'rename-inheritdoc',
-        transform: source => source.replace(/[a-zA-Z0-9$_]+$/, renameContract),
-      };
+    for (const doc of findAll('StructuredDocumentation', contract)) {
+      const bounds = getNodeBounds(doc);
+      const re = /(@inheritdoc\s+)([a-zA-Z0-9$_]+)/;
+      const match = matchBuffer(readOriginal(doc, 'buffer'), re);
+
+      if (match) {
+        yield {
+          start: bounds.start + match.start + match.captureLengths[0],
+          length: match.captureLengths[1],
+          kind: 'rename-inheritdoc',
+          transform: source => {
+            const ref = baseContracts.find(c => c?.canonicalName == source);
+            return ref !== undefined && getData(ref).importFromPeer !== undefined
+              ? source
+              : source.replace(/[a-zA-Z0-9$_]+$/, renameContract);
+          },
+        };
+      }
     }
   }
 }