Add file paths to error messages #173
Merged
Conversation
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
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add file reporting to error messages
Add file paths to error messages
Dec 24, 2025
alexec
approved these changes
Dec 24, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves error messages by adding file paths to parsing, unmarshaling, and parameter expansion errors, making it easier to debug issues when processing multiple files.
- Added file paths to error messages in markdown.go for open, scan, and unmarshal operations
- Added file paths to error messages in context.go for parse and parameter expansion errors in tasks, commands, and rules
- Added test coverage to verify file paths appear in error messages
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pkg/codingcontext/markdown/markdown.go | Added file path parameter to three error messages (open, scan, unmarshal frontmatter) for better error diagnostics |
| pkg/codingcontext/context.go | Added file path parameter to four error messages (task parse, task parameter expansion, command parameter expansion, rule parameter expansion) |
| pkg/codingcontext/markdown/markdown_test.go | Added test coverage for file path inclusion in error messages with table-driven test following project standards |
Comment on lines
+111
to
+125
| func TestParseMarkdownFile_ErrorsIncludeFilePath(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| content string | ||
| want string // substring that should appear in error | ||
| }{ | ||
| { | ||
| name: "invalid YAML in frontmatter", | ||
| content: `--- | ||
| invalid: yaml: : syntax | ||
| --- | ||
| Content here`, | ||
| want: "failed to unmarshal frontmatter in file", | ||
| }, | ||
| } |
There was a problem hiding this comment.
The test coverage for error messages is good, but it only covers the unmarshal error case. Consider adding a test case for the scan error on line 71 of markdown.go to ensure complete coverage of all file path error messages. However, since scanner errors are rare and difficult to simulate, this is a minor suggestion.
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.
File-related errors (parsing failures, YAML unmarshal errors, parameter expansion errors) did not indicate which file caused the issue, making debugging difficult when processing multiple files.
Changes:
Example:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.