Skip to content

Commit 1c1759f

Browse files
Merge pull request #275 from bonilokesh/fix/property-replay-usage-docs
docs: align property-replay usage with CLI and document --all mode
2 parents a42d216 + df7ef0f commit 1c1759f

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

‎research-kit/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,8 @@ node research-kit/bin/path-authority.mjs conform | validate
494494
node research-kit/bin/ledger-conformance.mjs --vectors <packet.json> --json
495495
node research-kit/bin/fi-sidecar-conformance.mjs --vectors <packet.json> --json
496496
node research-kit/bin/property-vector-conformance.mjs --vectors <packet.json> --json
497-
node research-kit/bin/property-replay.mjs --case <case-id>
497+
node research-kit/bin/property-replay.mjs --case <property-regression.json> [--json]
498+
node research-kit/bin/property-replay.mjs --all [--directory <property-regressions>] [--json]
498499
```
499500

500501
Status maps to exit code — `PASS` 0, `FAIL`/`REOPEN` 1, `INCOMPLETE` 2, `BLOCKED` 3 — and

‎research-kit/test/property-replay.test.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,7 @@ test('property-replay CLI documents its read-only replay modes', () => {
8484
assertEqual(run.status, 0, run.stderr || run.stdout);
8585
assert(run.stdout.includes('--case <property-regression.json>'), run.stdout);
8686
assert(run.stdout.includes('--all [--directory <property-regressions>]'), run.stdout);
87+
const readme = fs.readFileSync(path.join(ROOT, 'README.md'), 'utf8');
88+
assert(readme.includes('--case <property-regression.json> [--json]'), 'README documents --case');
89+
assert(readme.includes('--all [--directory <property-regressions>] [--json]'), 'README documents --all');
8790
});

0 commit comments

Comments
 (0)