Skip to content
This repository was archived by the owner on Dec 27, 2025. It is now read-only.

Commit da73161

Browse files
committed
docs: add missing fmt, lint, and check command documentation
The CLI has implemented fmt, lint, and check commands since the beginning, but they were not documented in the README. Users could only discover these commands through --help output. Added comprehensive documentation including: - Usage examples in the quick start section - Full command reference with all options - Implementation notes about Deno tool integration - Config file pattern support (includes/excludes) These commands wrap Deno's native tools (fmt, lint, check) with Probitas file discovery, making it easier for users to maintain their scenario files using familiar Deno tooling patterns.
1 parent 83e7c04 commit da73161

File tree

1 file changed

+97
-0
lines changed

1 file changed

+97
-0
lines changed

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,15 @@ probitas run --reporter json
109109
# List scenarios without running
110110
probitas list
111111

112+
# Format scenario files
113+
probitas fmt
114+
115+
# Lint scenario files
116+
probitas lint
117+
118+
# Type-check scenario files
119+
probitas check
120+
112121
# Show help
113122
probitas --help
114123
```
@@ -184,6 +193,94 @@ probitas init --force
184193
- `example.probitas.ts` - Example scenario file
185194
- `probitas.jsonc` - Configuration file
186195

196+
### `probitas fmt [paths...] [options]`
197+
198+
Format scenario files using Deno's formatter.
199+
200+
**Options:**
201+
202+
- `--include <pattern>` - Include pattern for file discovery
203+
- `--exclude <pattern>` - Exclude pattern for file discovery
204+
- `--config <path>` - Path to probitas config file
205+
- `--verbose, -v` - Verbose output
206+
- `--quiet, -q` - Suppress output
207+
- `--debug, -d` - Debug output
208+
209+
**Examples:**
210+
211+
```bash
212+
# Format all scenario files
213+
probitas fmt
214+
215+
# Format scenarios in specific directory
216+
probitas fmt api/
217+
218+
# Format with custom pattern
219+
probitas fmt --include "e2e/**/*.probitas.ts"
220+
```
221+
222+
**Note:** Runs `deno fmt --no-config` on discovered scenario files. Uses
223+
includes/excludes from probitas config (same as run/list).
224+
225+
### `probitas lint [paths...] [options]`
226+
227+
Lint scenario files using Deno's linter.
228+
229+
**Options:**
230+
231+
- `--include <pattern>` - Include pattern for file discovery
232+
- `--exclude <pattern>` - Exclude pattern for file discovery
233+
- `--config <path>` - Path to probitas config file
234+
- `--verbose, -v` - Verbose output
235+
- `--quiet, -q` - Suppress output
236+
- `--debug, -d` - Debug output
237+
238+
**Examples:**
239+
240+
```bash
241+
# Lint all scenario files
242+
probitas lint
243+
244+
# Lint scenarios in specific directory
245+
probitas lint api/
246+
247+
# Lint with custom pattern
248+
probitas lint --include "e2e/**/*.probitas.ts"
249+
```
250+
251+
**Note:** Runs `deno lint --no-config` on discovered scenario files. Uses
252+
includes/excludes from probitas config (same as run/list). Automatically
253+
excludes rules: `no-import-prefix`, `no-unversioned-import`.
254+
255+
### `probitas check [paths...] [options]`
256+
257+
Type-check scenario files using Deno's type checker.
258+
259+
**Options:**
260+
261+
- `--include <pattern>` - Include pattern for file discovery
262+
- `--exclude <pattern>` - Exclude pattern for file discovery
263+
- `--config <path>` - Path to probitas config file
264+
- `--verbose, -v` - Verbose output
265+
- `--quiet, -q` - Suppress output
266+
- `--debug, -d` - Debug output
267+
268+
**Examples:**
269+
270+
```bash
271+
# Type-check all scenario files
272+
probitas check
273+
274+
# Check scenarios in specific directory
275+
probitas check api/
276+
277+
# Check with custom pattern
278+
probitas check --include "e2e/**/*.probitas.ts"
279+
```
280+
281+
**Note:** Runs `deno check --no-config` on discovered scenario files. Uses
282+
includes/excludes from probitas config (same as run/list).
283+
187284
## Selectors
188285

189286
Selectors filter scenarios by name or tags:

0 commit comments

Comments
 (0)