Document --dry-run CLI flag and dryRun config option#26
Closed
promptless[bot] wants to merge 2 commits into
Closed
Document --dry-run CLI flag and dryRun config option#26promptless[bot] wants to merge 2 commits into
promptless[bot] wants to merge 2 commits into
Conversation
Add documentation for the new dry-run feature that resolves tests without executing them, outputting the resolved test plan as JSON. Useful for debugging config and verifying test setup.
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| npx doc-detective --config .doc-detective.json --dry-run | ||
|
|
||
| # Or validate with JSON Schema | ||
| npx ajv validate -s https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json -d .doc-detective.json |
Contributor
Author
There was a problem hiding this comment.
Added dryRun config field and --dry-run CLI flag documentation based on PR #292 which implements the feature in src/utils.ts and src/core/index.ts.
Source: doc-detective/doc-detective#292
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Open this suggestion in Promptless to view citations and reasoning process
Documents the new --dry-run CLI flag and dryRun config field that resolves tests without executing them, outputting the resolved test plan as JSON. Includes use cases for debugging config issues and CI validation.
Trigger Events
Tip: Use Vale? Add your vale.ini when setting up your Docs Collection.