[PSR-19] Proposal for adding generated tag #1249
Merged
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.
This PR is a proposal to add a
@generated
tag in PSR-19. This tag indicates that the code has been generated using an automation script. This is quite common in projects where the code is generated from a specification (e.g. OpenAPI). This tag should be used to warn to do not change the code, since the change will be overwritten by theautomation script.
For instance, you can mark a PHP class that has been generated using a script, as follows:
The comment in the
@generated
class can useful to give information about the automation script. In this way people can contribute to the automation script rather than doing the mistake of chaning the code manually.Moreover, the
@generated
tag can be used to automate alert (e.g. using Github Action) for manual change in the code.