docs(version): set 3.1 as the recommended version

Author: Rubilmax

.github/workflows/foundry-storage-check.yml

@@ -25,6 +25,6 @@ jobs:
           version: nightly
 
       - name: Check storage layout
-        uses: Rubilmax/foundry-storage-check@v3.0.2
+        uses: Rubilmax/foundry-storage-check@v3.1
         with:
           contract: contracts/Example.sol:Example

README.md

@@ -51,7 +51,7 @@ jobs:
           version: nightly
 
       - name: Check storage layout
-        uses: Rubilmax/[email protected].0
+        uses: Rubilmax/[email protected]
         with:
           contract: src/Contract.sol:Contract
           # settings below are optional, but allows to check whether the added storage slots are empty on the deployed contract

src/index.ts

@@ -140,7 +140,7 @@ async function run() {
 
     if (diffs.length > 0) {
       core.info(`Parse source code`);
-      const cmpDef = parseSource(contract);
+      const cmpDef = parseSource(contract, workingDirectory);
 
       const formattedDiffs = diffs.map((diff) => {
         const formattedDiff = formatDiff(cmpDef, diff);

src/input.ts

@@ -1,5 +1,6 @@
 import { execSync } from "child_process";
 import fs from "fs";
+import { join } from "path";
 
 import * as parser from "@solidity-parser/parser";
 import { ContractDefinition } from "@solidity-parser/parser/src/ast-types";
@@ -49,8 +50,9 @@ export const parseLayout = (content: string): StorageLayoutReportExact => {
   }
 };
 
-export const parseSource = (contract: string): ParsedSource => {
-  const [path, contractName] = contract.split(":");
+export const parseSource = (contract: string, cwd = ""): ParsedSource => {
+  const [relPath, contractName] = contract.split(":");
+  const path = join(cwd, relPath);
 
   const { children, tokens = [] } = parser.parse(fs.readFileSync(path, { encoding: "utf-8" }), {
     tolerant: true,

tests/input.test.ts

@@ -0,0 +1,22 @@
+import { expect } from "@jest/globals";
+
+import { createLayout, parseLayout, parseSource } from "../src/input";
+
+describe("Input checks", () => {
+  it("should execute createLayout from a custom working directory", async () => {
+    const layout = parseLayout(createLayout("StorageRef.sol:Storage", "tests/mocks/basic"));
+
+    expect(Object.keys(layout.storage)).toHaveLength(8);
+    expect(Object.keys(layout.types)).toHaveLength(9);
+  });
+
+  it("should execute parseLayout from a custom working directory", async () => {
+    const source = parseSource("StorageRef.sol:Storage", "tests/mocks/basic");
+
+    expect(source.def.name).toBe("Storage");
+    expect(source.def.baseContracts).toHaveLength(0);
+    expect(source.def.kind).toBe("contract");
+    expect(source.def.type).toBe("ContractDefinition");
+    expect(source.path).toBe("tests/mocks/basic/StorageRef.sol");
+  });
+});