Skip to content

Commit

Permalink
docs: clarify options in README (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
gas1cent authored Apr 4, 2024
1 parent 507b6e2 commit 6194fb8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ yarn add @defi-wonderland/smock-foundry --save-dev
To generate the mock contracts all you have to do is run:

```bash
yarn smock-foundry --contracts path/to/contracts
yarn smock-foundry --contracts solidity/contracts
```

The `smock-foundry` command accepts the following options:

Option | Default | Notes
------------|-----------------------------------|-------
`contracts` | — | The path to the solidity contracts to mock
`out` | `./out` | The path that has the compiled artifacts
`mocks ` | `./solidity/test/smock` | The path to the generated mock contracts
`root` | `.` | The path to the root of the project
`mocks ` | `./test/smock` | The path to the generated mock contracts
`ignore` | [] | A list of directories to ignore, e.g. `--ignore libraries`

Be sure to `gitignore` the generated smock directory.
Expand All @@ -58,7 +58,7 @@ contract Greeter {
}
```

After running the generator, you will have a mock contract located at `${genDir}/contracts/MockGreeter.sol`:
After running the generator, you will have a mock contract located at `${mocks}/contracts/MockGreeter.sol`:

```solidity
contract MockGreeter is Greeter {
Expand Down
2 changes: 1 addition & 1 deletion src/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function getProcessArguments() {
type: 'string',
},
ignore: {
describe: 'Ignore folders',
describe: 'Ignore directories',
default: [],
type: 'array',
string: true,
Expand Down

0 comments on commit 6194fb8

Please sign in to comment.