use @generated mark in files created by sea-orm-codegen
#2199
Conversation
This file contains 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
This makes it easier for external tools to identify these files as generated and treat them differently according to their own configuration.
|
The RC period is for breaking changes :D |
🎉 Released In 1.0.0-rc.4 🎉Thank you everyone for the contribution! |
🎉 Released In 1.0.0 🎉Thank you everyone for the contribution! |
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.
Changes the doc header on generated files to include
@generated. This makes it easier for external tools to identify these files as generated and treat them differently according to their own configuration, e.g., code formatters might ignore them. This is the de facto way to indicate a file has been automatically generated, and evenCargo.lockuses it.This can perhaps be considered a breaking change if someone is relying on the current exact header, so an alternative would be to keep the current comment and add another line after it with
// @generated. On the other hand, that would mean almost anything at all changing this crate's writers would too be a breaking change, which is debatable -- this PR does not introduce any changes to e.g. function signatures.Breaking Changes
@generated