Add @generated marker to uv.lock files
#16277
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
This adds a comment containing the `@generated` marker to the top of all `uv.lock` files. The `@generated` marker is a widely-adopted convention (see https://generated.at/) that helps tools (like IDEs, code formatters, and code review tools) identify files as generated and handle them appropriately. Other common tools use this marker in lock files as well (such as Cargo and Poetry). Fixes astral-sh#13878.
jackrosenthal
force-pushed
the
at-generated
branch
from
29cf28c to
779e169
Compare
|
I don't think we have reached consensus that this should be done. |
fabi125
reviewed
Oct 16, 2025
|
|
||
| let content = doc.to_string(); | ||
| Ok(format!( | ||
| "# This file was @generated by uv. Do not edit by hand.\n{content}" |
There was a problem hiding this comment.
Could we use a single space after the period? Basically every single style guide on earth recommends a single space (even when using a monospace font).
e.g. see https://cmosshoptalk.com/2020/03/24/one-space-or-two/ or https://apastyle.apa.org/style-grammar-guidelines/paper-format/accessibility/typography#myth4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Summary
This adds a comment containing the
@generatedmarker to the top ofall
uv.lockfiles. The@generatedmarker is a widely-adoptedconvention (see https://generated.at/) that helps tools (like IDEs,
code formatters, and code review tools) identify files as generated
and handle them appropriately.
Other common tools use this marker in lock files as well (such as Cargo
and Poetry).
Fixes #13878.
Test Plan
uv lock