Better diagnostics for duplicate headers #281
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR improves diagnostics for duplicate headers in scaffolding data by enhancing error handling and output messaging. The key changes include:
- Introducing a try-catch block in the CSV conversion method to provide detailed diagnostics when duplicate headers are encountered.
- Logging the duplicate header information and the full header row to the console.
- Replacing hardcoded separator values with a dedicated constant.
| } | ||
| catch (Exception e) | ||
| { | ||
| if (e.Message.Contains("Duplicate headers detected in HeaderPresent mode.")) |
There was a problem hiding this comment.
Relying on substring matching of the exception message to detect duplicate headers can be fragile. Consider catching a more specific exception type if available or checking a dedicated error code.
| if (e.Message.Contains("Duplicate headers detected in HeaderPresent mode.")) | ||
| { | ||
| var headerRow = fileLines.First(); | ||
| Console.WriteLine( |
There was a problem hiding this comment.
Using Console.WriteLine for diagnostics in production code may not be the best choice. Consider using a structured logging framework to improve maintainability and traceability.
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.
What have I made? 👩💻
Better diagnostics for duplicate headers in scaffolding data.
How can you best review this? 🧐
Is the output helpful?
Did I remember everything checklist?