Documentation for report command in keploy oss #635
Conversation
|
To generate Unit Tests for this PR, please click here. |
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
github-actions
bot
force-pushed
the
feat/report
branch
from
b5b358e to
226264d
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the report command in Keploy CLI, addressing issue #2919. The documentation explains how to use the command to display detailed test result summaries and human-readable diffs for failed test cases.
- Added
reportcommand to the commands table with available flags - Documented usage, purpose, and all available flags with examples
- Provided practical examples for each flag option
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| | `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | | ||
| | `normailze` | `-p, --path`, `--test-run`, `--tests` | | ||
| | `rerecord` | `--test-sets`, `-t` | | ||
| | `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--full-body` | |
There was a problem hiding this comment.
The flag documentation is inconsistent. The -r alias for --report-path is shown in the table but not mentioned in the detailed flag description at line 351. Either add the -r alias to the detailed description or remove it from the table for consistency.
|
|
||
| <b> Available flags: </b> | ||
|
|
||
| - `-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`. |
There was a problem hiding this comment.
The term 'Testsets' should be 'Test sets' (two words) for proper grammar and consistency with the rest of the documentation.
| - `-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`. | |
| - `-t, --test-sets strings` - Test sets to report, e.g., `--test-sets "test-set-1, test-set-2"`. |
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
github-actions
bot
force-pushed
the
feat/report
branch
from
f80b6cc to
ac30414
Compare
What has changed?
Please include a summary of the change.
This PR Resolves keploy/keploy#2919
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
Checklist: