Make orphan-count message wording consistent regardless of count - #213
Merged
Conversation
Previously the orphan summary line varied its verb and noun forms based on count (e.g. 'requirements are orphaned' vs '1 of 382 requirements is orphaned'), which made the message harder for tooling/agents to match on a single consistent pattern. Drop the is/are verb and the singular/plural requirement noun switch entirely, always producing 'X of Y requirements orphaned (...)'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are narrowly scoped to message wording and all known references in tests and docs were updated consistently.
Pull request overview
Standardizes the orphan-summary output line so it no longer switches grammar based on the orphan/total counts, improving stability for programmatic matching in ReqStream CLI output.
Changes:
- Simplified
ReportOrphansto always emitX of Y requirements orphaned ...(no is/are or requirement/requirements switching). - Updated test assertions to match the new fixed wording.
- Updated documentation examples (README and usage standard) to match the new output.
File summaries
| File | Description |
|---|---|
| src/DemaConsulting.ReqStream/Program.cs | Removes count-based grammar switching and emits a fixed orphan-summary line. |
| test/DemaConsulting.ReqStream.Tests/ProgramTests.cs | Updates assertions to match the new orphan-summary wording. |
| README.md | Updates example CLI output to the fixed orphan-summary message. |
| .github/standards/reqstream-usage.md | Updates standards/example output to the fixed orphan-summary message. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
Agreed with the maintainer that varying the orphan-summary line's grammar
by count (
requirements are orphanedfor plural totals/counts vs.1 of N requirements is orphanedfor a singular orphan count) makes themessage inconsistent to match against programmatically. This drops the
is/are verb switch and the requirement/requirements noun switch, so the
message always reads:
X of Y requirements orphaned (not reachable from any requirement tagged: ...).Changes
Program.cs: simplifiedReportOrphansto emit the fixed wordingregardless of
OrphanIds.Count/TotalRequirements.ProgramTests.csassertions,README.md, and.github/standards/reqstream-usage.mdexample output to match.Validation
pwsh ./build.ps1-> build succeeded, 1002 passed / 3 skipped (Unix-only) across net8/9/10.pwsh ./fix.ps1/pwsh ./lint.ps1-> clean, no lint errors.