Respect .editorconfig end_of_line and charset in generated code
#2114
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
YoelDruxman
force-pushed
the
feat/editorconfig-settings
branch
6 times, most recently
from
4199944 to
3194a3e
Compare
Contributor
|
Thank you for this contribution. Before I start the review, I’d like to clarify a few open questions:
|
Author
|
Thank you @latonz! I am still working on this. Let me consider your feedback and update the PR or at least report back. |
YoelDruxman
changed the title
end_of_line and charset in generated code
Author
|
@latonz I think this is ready for your review. Your thoughtful questions led to changing the implementation for the better:
Here is a report I created with Claude that delves a little deeper. Please let me know what you think. Any feedback is welcome! Thank you for this wonderful library! |
Generated mapper files (.g.cs) now honor .editorconfig settings: - end_of_line: supports lf, crlf, cr (defaults to crlf) - charset: supports utf-8, utf-8-bom, utf-16be, utf-16le (defaults to utf-8 without BOM) This allows generated code to match the project's line ending and encoding preferences, avoiding git diffs and post-processing requirements. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Use the mapper source file path (.cs) instead of trying to create a synthetic tree with the generated file path (.g.cs). This provides reliable editorconfig support with a documented limitation. Note: [*.g.cs] patterns are not supported due to a Roslyn limitation. Users should configure settings in [*.cs] or [*] sections. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Instead of GetText().ToString().Replace() which creates 2 string allocations for non-CRLF line endings, use SyntaxNode.WriteTo() with a custom LineEndingTextWriter that replaces CRLF on-the-fly. This reduces allocations from 2 to 1 for LF/CR configurations while maintaining the fast path (no replacement) for CRLF (default). Co-Authored-By: Claude Opus 4.5 <[email protected]>
Clarifies that settings are read from the source file containing the mapper declaration, not from generated files. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
YoelDruxman
force-pushed
the
feat/editorconfig-settings
branch
from
72bed81 to
76d8d14
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Respect .editorconfig
end_of_lineandcharsetin generated codeDescription
Generated mapper files (
.g.cs) now respect.editorconfigsettings for line endings and character encoding.Problem
Generated code always used CRLF (
\r\n) line endings and UTF-8 without BOM, regardless of the project's.editorconfigconfiguration. This caused issues for projects configured with different line endings.Solution
Read
end_of_lineandcharsetsettings from the source file's.editorconfigviaAnalyzerConfigOptionsProviderand apply them to the generated output.Supported settings:
end_of_line:lf,crlf,cr(defaults tocrlf)charset:utf-8,utf-8-bom,utf-16be,utf-16le(defaults toutf-8without BOM)Known Limitation
Due to a Roslyn limitation, editorconfig settings are read from the source file containing the mapper declaration, not from generated
.g.csfiles. This means[*.g.cs]patterns in.editorconfigwill not be applied. Users should configure settings in[*.cs]or[*]sections.Files changed:
LineEndingTextWriter.cs- Streaming line ending replacementIncrementalValuesProviderExtensions.cs- Read editorconfig settings and apply encodingMapperNode.cs- StoreEndOfLineandCharsetpropertiesMapperGenerator.cs- Pass settings from source file to outputAddresses this discussion
Checklist