Add checked-files list to JSON diagnostic report - #26
Merged
Merged
Conversation
Adds a 'files' array to the JSON lint report, listing every file the effective file selection resolved to (post include/exclude/glob resolution), with a path and a status field (currently always 'checked', left extensible for a future 'excluded' status). This removes the need for callers to independently reimplement the tool's glob/include/exclude resolution just to learn which files a run examined, previously exposed only as an opaque filesChecked count. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
One or more issues must be addressed before approval.
Review effort: Lite
Findings: 1
What changed in this PR
Adds a files array to JSON lint reports, exposing checked paths and statuses.
Changes:
- Propagates resolved file paths through the linter and reporter.
- Adds unit and integration coverage.
- Updates design, verification, and requirements artifacts.
| File | Description |
|---|---|
| test/DemaConsulting.Ste100Mark.Tests/Linting/LinterTests.cs | Updated as part of this pull request. |
| test/DemaConsulting.Ste100Mark.Tests/Linting/DiagnosticReporterTests.cs | Updated as part of this pull request. |
| test/DemaConsulting.Ste100Mark.Tests/IntegrationTests.cs | Updated as part of this pull request. |
| src/DemaConsulting.Ste100Mark/Linting/Linter.cs | Updated as part of this pull request. |
| src/DemaConsulting.Ste100Mark/Linting/DiagnosticReporter.cs | Updated as part of this pull request. |
| docs/verification/ste100-mark/linting.md | Updated as part of this pull request. |
| docs/reqstream/ste100-mark/linting.yaml | Updated as part of this pull request. |
| docs/reqstream/ste100-mark.yaml | Updated as part of this pull request. |
| docs/design/ste100-mark/linting/diagnostic-reporter.md | Updated as part of this pull request. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Pull Request
Description
Adds a
filesarray to the JSON lint report, listing every file the effective file selectionresolved to (post glob/include/exclude resolution), with a
pathand astatusfield (always"checked"today; the field is deliberately extensible so a future release can add"excluded"entries without a breaking schema change).
Previously the JSON report exposed only an opaque
filesChecked: Ncount. A caller that neededto know which files a run examined (for example, to attribute findings to document sections) had
to independently reimplement the tool's glob/include/exclude semantics just to recover that
information, creating a second, drift-prone copy of the tool's file-selection logic. This closes
that gap by having the tool report the resolved file list directly.
Scope note: this feature reports only files that were actually checked (post-exclusion). It does
not enumerate excluded files with exclusion reasons - that fuller ask is tangled with a separate,
currently-blocked design question about explicit-path vs. config-selection precedence, and is
left for a future PR.
Type of Change
Related Issues
Closes #
Pre-Submission Checklist
Build and Test
pwsh ./build.ps1- 1326/1326 passedCode Quality
Quality Checks
pwsh ./lint.ps1- cleanTesting
Documentation
Ste100Mark-Linting-ReportedFilesandSte100Mark-System-LintReportedFilesAdditional Notes
Text-mode output is intentionally unchanged (still only shows the summary count) to avoid
unbounded per-file console output on large repositories; only JSON mode gains the
filesarray.