chore: Fix README for @layerzerolabs/ua-utils-evm-hardhat; Add DOCKER…

…_COMPOSE_RUN_TESTS_ARGS
LayerZero-Labs · Nov 24, 2023 · 8fa00e2 · 8fa00e2
1 parent 89be5e7
commit 8fa00e2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 15 deletions.
diff --git a/packages/ua-utils-evm-hardhat-test/README.md b/packages/ua-utils-evm-hardhat-test/README.md
@@ -4,24 +4,28 @@
   </a>
 </p>
 
-<h1 align="center">@layerzerolabs/utils-evm-hardhat</h1>
+<h1 align="center">@layerzerolabs/utils-evm-hardhat-test</h1>
 
-<!-- The badges section -->
-<p align="center">
-  <!-- Shields.io NPM published package version -->
-  <a href="https://www.npmjs.com/package/@layerzerolabs/utils-evm-hardhat"><img alt="NPM Version" src="https://img.shields.io/npm/v/@layerzerolabs/utils-evm-hardhat"/></a>
-  <!-- Shields.io NPM downloads -->
-  <a href="https://www.npmjs.com/package/@layerzerolabs/utils-evm-hardhat"><img alt="Downloads" src="https://img.shields.io/npm/dm/@layerzerolabs/utils-evm-hardhat"/></a>
-  <!-- Shields.io license badge -->
-  <a href="https://www.npmjs.com/package/@layerzerolabs/utils-evm-hardhat"><img alt="NPM License" src="https://img.shields.io/npm/l/@layerzerolabs/utils-evm-hardhat"/></a>
-</p>
+## Development
 
-## Installation
+This package provides integration tests for `@layerzerolabs/utils-evm-hardhat` executed within a containerized setup. To run the test suite, simply run:
 
 ```bash
-yarn add @layerzerolabs/utils-evm-hardhat
+# You can use the alias command from this package directory
+yarn test
+
+# Or use turbo and run from project root
+yarn test --filter=utils-evm-hardhat-test
 
-pnpm add @layerzerolabs/utils-evm-hardhat
+# Or just use the actual test command from this package directory
+docker compose run --rm tests
+```
+
+In case you're running the tests from the project root, it might sometimes be useful to rebuild the containers
+(for example when adding/removing dependencies) and as a lazy developer, you might not be happy about `cd`ing to the package directory
+and run the command from there. For that usecase the `$DOCKER_COMPOSE_RUN_TESTS_ARGS` environment variable has been added:
 
-npm install @layerzerolabs/utils-evm-hardhat
+```bash
+# To rebuild the containers before running tests from the project root
+DOCKER_COMPOSE_RUN_TESTS_ARGS=--build yarn test --filter=utils-evm-hardhat-test
 ```
diff --git a/packages/ua-utils-evm-hardhat-test/package.json b/packages/ua-utils-evm-hardhat-test/package.json
@@ -11,7 +11,7 @@
   "license": "MIT",
   "scripts": {
     "lint": "npx eslint '**/*.{js,ts,json}'",
-    "test": "docker compose run --rm tests"
+    "test": "docker compose run --rm $DOCKER_COMPOSE_RUN_TESTS_ARGS tests"
   },
   "devDependencies": {
     "@ethersproject/abstract-signer": "^5.7.0",