Ignore files marked with @generated marker #1689
Merged
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
`@generated` marker is used by certain tools to understand that the file is generated, so it should be treated differently than a file written by a human: * these files do not need to be reformatted, * diffs in these files are less important, * and linters should not be invoked on these files. This PR proposes builtin support for `@generated` marker (and `@not-generated` marker to mark file as not generated when it contains `@generated` marker, like `README.md`). I have not found a standard for a generated file marker, but: * Facebook [uses `@generated` marker](https://tinyurl.com/fb-generated) * Phabricator tool which was spawned from Facebook internal tool [also understands `@generated` marker](https://git.io/JnVHa) * Cargo inserts `@generated` marker into [generated Cargo.lock files](https://git.io/JnVHP) Super-linter supports regex includes and excludes, but they are harder to maintain (each repository needs to be configured) than patching the tools which generate the files. My personal story is that I maintain rust-protobuf crate, which started emitting `@generated` markers [six years ago](https://git.io/JnV5h) after a request of a Phabricator user. Test Plan: Create a test file `test.sh`: ``` echo $a ``` Run: ``` docker run -e RUN_LOCAL=true -v $HOME/tmp/g:/tmp/lint super-linter-test ``` Result is: ``` In /tmp/lint/test.sh line 1: echo $a ^-- SC2148: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive. ^-- SC2154: a is referenced but not assigned. ^-- SC2086: Double quote to prevent globbing and word splitting. ... 2021-06-22 23:46:16 [ERROR] ERRORS FOUND in BASH:[1] ``` Now add `@generated` to the file and run again: ``` 2021-06-22 23:47:13 [NOTICE] All file(s) linted successfully with no errors detected ``` Additionally, add `@not-generated` in addition to `@generated`, and linter error pops up again.
stepancheg
requested review from
admiralAwkbar,
ferrarimarco,
GaboFDC,
Hanse00,
jwiebalk,
nemchik and
zkoppert
as code owners
|
Perhaps this need to be labeled as "enhancement" but GitHub doesn't allow me to do that. |
ferrarimarco
added
documentation
|
@stepancheg thanks for this PR! This looks interesting. I added a few comments |
ferrarimarco
requested changes
Jun 23, 2021
|
Amended the PR:
|
ferrarimarco
requested changes
Jun 23, 2021
|
Nice work! |
|
Updated the readme. |
|
I have created a little website to promote |
|
@admiralAwkbar want to have a look as well? |
|
@ferrarimarco all good to you? |
|
So the fail was from |
This was referenced Oct 3, 2021
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.
@generatedmarker is used by certain tools to understand that thefile is generated, so it should be treated differently than a file
written by a human:
This PR proposes builtin support for
@generatedmarker (and@not-generatedmarker to mark file as not generated when itcontains
@generatedmarker, likeREADME.md).I have not found a standard for a generated file marker, but:
@generatedmarkeralso understands
@generatedmarker@generatedmarker into generated Cargo.lock filesSuper-linter supports regex includes and excludes, but they are
harder to maintain (each repository needs to be configured) than
patching the tools which generate the files.
My personal story is that I maintain rust-protobuf crate, which
started emitting
@generatedmarkers six years agoafter a request of a Phabricator user.
Test Plan:
Create a test file
test.sh:Run:
Result is:
Now add
@generatedto the file and run again:Additionally, add
@not-generatedin addition to@generated, andlinter error pops up again.
Readiness Checklist
Author/Contributor
Reviewing Maintainer
breakingif this is a large fundamental changeautomation,bug,documentation,enhancement,infrastructure, orperformance