Include test utils in NPM package (#179)

* build: include test utils in package build: install prb test as npm package build: install forge as npm package build: remove gitmodules ci: install node js dependencies in build and test job chore: update remappings accordingly * chore: update Slither config * ci: install Node.js in Slither job * chore: remove "lib" references * docs: update installation instructions --------- Co-authored-by: Paul Razvan Berg <[email protected]>
PaulRBerg · Dec 5, 2023 · d3086c3 · d3086c3
1 parent 245e2bd
commit d3086c3
Show file tree

Hide file tree

Showing 18 changed files with 76 additions and 52 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -52,8 +52,6 @@ jobs:
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
-        with:
-          submodules: "recursive"
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
@@ -103,8 +101,6 @@ jobs:
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
-        with:
-          submodules: "recursive"
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
@@ -116,6 +112,20 @@ jobs:
           key: "foundry-build-${{ github.sha }}"
           path: "out-optimized"
 
+      - name: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
+
       - name: "Run the tests against the optimized build"
         run: "FOUNDRY_PROFILE=test-optimized forge test"
 
@@ -130,12 +140,24 @@ jobs:
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
-        with:
-          submodules: "recursive"
 
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
 
+      - name: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
+
       - name: "Run the tests and generate the coverage report"
         run: "forge coverage --report lcov"
 
@@ -155,8 +177,20 @@ jobs:
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
+
+      - name: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
         with:
-          submodules: "recursive"
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
 
       - name: "Run Slither"
         uses: "crytic/[email protected]"

diff --git a/.gitmodules b/.gitmodules
diff --git a/.prettierignore b/.prettierignore
@@ -2,7 +2,6 @@
 broadcast
 cache
 coverage
-lib
 node_modules
 out-optimized
 out

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,6 +9,5 @@
     ".gas-snapshot": "julia"
   },
   "editor.formatOnSave": true,
-  "npm.exclude": "**/lib/**",
   "solidity.formatter": "forge"
 }
diff --git a/README.md b/README.md
@@ -79,35 +79,20 @@ Alternatively, you can:
 
 You can get access to the Solidity code and the ABIs programmatically.
 
-### Foundry
-
-First, run the install step:
+All users are recommended to install PRBProxy as a Node.js package:
 
 ```sh
-forge install PaulRBerg/prb-proxy@release-v4
+pnpm add @prb/math
 ```
 
-Your `.gitmodules` file should now contain the following entry:
+This example uses Pnpm, but using Yarn or Npm is also possible.
 
-```toml
-[submodule "lib/prb-proxy"]
-  branch = "release-v4"
-  path = "lib/prb-proxy"
-  url = "https://github.com/PaulRBerg/prb-proxy"
-```
+### Foundry
 
-Finally, add this to your `remappings.txt` file:
+If you're using Foundry, you have to add this to your `remappings.txt` file:
 
 ```text
-prb-proxy/=lib/prb-proxy/
-```
-
-### Hardhat
-
-PRBProxy is available as an npm package:
-
-```sh
-pnpm add @prb/proxy
+@prb/proxy/=node_modules/@prb/proxy/
 ```
 
 ## Usage

diff --git a/foundry.toml b/foundry.toml
@@ -8,7 +8,6 @@
   ignored_error_codes = [
     5159, # ignore selfdestruct warning
   ]
-  libs = ["lib"]
   optimizer = true
   optimizer_runs = 200
   out = "out"

diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/prb-test b/lib/prb-test
diff --git a/package.json b/package.json
@@ -10,12 +10,15 @@
     "url": "https://github.com/PaulRBerg/prb-proxy/issues"
   },
   "devDependencies": {
+    "@prb/test": "0.6.4",
+    "forge-std": "github:foundry-rs/forge-std#e8a047e3f40f13fa37af6fe14e6e06283d9a060e",
     "prettier": "^2.8.8",
     "solhint-community": "^3.5.2"
   },
   "files": [
     "artifacts",
     "src",
+    "test/utils",
     "CHANGELOG.md"
   ],
   "homepage": "https://github.com/PaulRBerg/prb-proxy#readme",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/remappings.txt b/remappings.txt
@@ -1,2 +1,2 @@
-@prb/test/=lib/prb-test/src/
-forge-std/=lib/forge-std/src/
+@prb/test/=node_modules/@prb/test
+forge-std/=node_modules/forge-std/
diff --git a/script/Base.s.sol b/script/Base.s.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.19 <=0.9.0;
 
-import { Script } from "forge-std/Script.sol";
+import { Script } from "forge-std/src/Script.sol";
 
 abstract contract BaseScript is Script {
     /// @dev Included to enable compilation of the script without a $MNEMONIC environment variable.

diff --git a/slither.config.json b/slither.config.json
@@ -1,4 +1,4 @@
 {
   "detectors_to_exclude": "low-level-calls,naming-convention,reentrancy-events,solc-version",
-  "filter_paths": "(lib|test)"
+  "filter_paths": "(test)"
 }
diff --git a/test/Base.t.sol b/test/Base.t.sol
@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity >=0.8.19 <=0.9.0;
 
-import { eqString } from "@prb/test/Helpers.sol";
-import { StdCheats } from "forge-std/StdCheats.sol";
-import { StdUtils } from "forge-std/StdUtils.sol";
+import { eqString } from "@prb/test/src/Helpers.sol";
+import { StdCheats } from "forge-std/src/StdCheats.sol";
+import { StdUtils } from "forge-std/src/StdUtils.sol";
 
 import { IPRBProxy } from "../src/interfaces/IPRBProxy.sol";
 import { IPRBProxyRegistry } from "../src/interfaces/IPRBProxyRegistry.sol";

diff --git a/test/proxy/execute/execute.t.sol b/test/proxy/execute/execute.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity >=0.8.19 <=0.9.0;
 
-import { stdError } from "forge-std/StdError.sol";
+import { stdError } from "forge-std/src/StdError.sol";
 
 import { IPRBProxy } from "src/interfaces/IPRBProxy.sol";
 

diff --git a/test/proxy/run-plugin/runPlugin.t.sol b/test/proxy/run-plugin/runPlugin.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity >=0.8.18 <0.9.0;
 
-import { stdError } from "forge-std/StdError.sol";
+import { stdError } from "forge-std/src/StdError.sol";
 
 import { IPRBProxy } from "src/interfaces/IPRBProxy.sol";
 

diff --git a/test/utils/Assertions.sol b/test/utils/Assertions.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.18;
 
-import { PRBTest } from "@prb/test/PRBTest.sol";
+import { PRBTest } from "@prb/test/src/PRBTest.sol";
 
 import { IPRBProxyPlugin } from "../../src/interfaces/IPRBProxyPlugin.sol";