Skip to content

Commit

Permalink
Merge pull request #24 from Ramyromel/add-test-command
Browse files Browse the repository at this point in the history
Add test command documentation
  • Loading branch information
Ramyromel authored Nov 29, 2024
2 parents 9a7e893 + 6178cea commit 426163f
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/cli/api/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [`init`](/cli/api/commands/init) Creates configuration file.
- [`generate`](/cli/api/commands/generate) Generates code based on configuration, using `contracts` and `plugins`.
- [`test`](/cli/api/commands/test) Runs tests based on configuration.

## Display Info

Expand Down Expand Up @@ -51,3 +52,52 @@ bun wagmi --version
```
:::

## Test Command

The `test` command runs tests based on the configuration provided.

### Usage

```bash
wagmi test
```

### Options

#### -c, --config <path>

`string`

Path to config file.

```bash
wagmi test --config wagmi.config.ts
```

#### -r, --root <path>

`string`

Root path to resolve config from.

```bash
wagmi test --root path/to/root
```

#### -w, --watch

`boolean`

Watch for changes and re-run tests.

```bash
wagmi test --watch
```

#### -h, --help

Displays help message.

```bash
wagmi test --help
```
49 changes: 49 additions & 0 deletions docs/cli/api/commands/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# test

Runs tests based on the configuration provided.

## Usage

```bash
wagmi test
```

## Options

### -c, --config <path>

`string`

Path to config file.

```bash
wagmi test --config wagmi.config.ts
```

### -r, --root <path>

`string`

Root path to resolve config from.

```bash
wagmi test --root path/to/root
```

### -w, --watch

`boolean`

Watch for changes and re-run tests.

```bash
wagmi test --watch
```

### -h, --help

Displays help message.

```bash
wagmi test --help
```

0 comments on commit 426163f

Please sign in to comment.