Add the string '@generated' to the lockfile #6890
Closed
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
added 3 commits
January 9, 2019 17:37
Various tools such as linters look for the string '@generated' in a file and use this to skip processing of the file. This change will help prevent linters from targeting the yarn.lock lockfile, as there is no benefit to performing things such as line length checks on this file.
|
I would be wary of this change because it'll also cause UIs not to display the file diffs. I don't want to make code reviews harder (related, github-linguist/linguist#4348). |
|
I'm sorry I won't merge it - I don't think the pros out-weight the cons, so I prefer to keep things the same. Thanks for the contribution, though, I look forward to see other PRs if you feel like it 🙂 |
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.
Summary
Various tools such as linters look for the string
'@generated'in a file and use this to skip processing of the file. This change will help prevent linters from targeting the yarn.lock lockfile, as there is no benefit to performing things such as line length checks on this file.Test plan
On the next update to the lock file, you should observe a new comment line near the top of the
yarn.lockfile. It should look like the following: