search

SeaQL / sea-orm

🐚 An async & dynamic ORM for Rust
https://www.sea-ql.org/SeaORM/
Apache License 2.0
6.56k stars 459 forks source link

use @generated mark in files created by `sea-orm-codegen` #2199

Closed RafDevX closed 2 months ago

RafDevX commented 2 months ago

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 even Cargo.lock uses 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

tyt2y3 commented 2 months ago

The RC period is for breaking changes :D

github-actions[bot] commented 1 month ago

:tada: Released In 1.0.0-rc.4 :tada:

Thank you everyone for the contribution! This feature is now available in the latest release. Now is a good time to upgrade! Your participation is what makes us unique; your adoption is what drives us forward. You can support SeaQL 🌊 by starring our repos, sharing our libraries and becoming a sponsor ⭐.