Composer: Document expected usage for security. #156
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
The JSON format does not allow comments because, in theory, it's only a data-exchange format. In reality, it's widely used in situations like this where comments are extremely important. To work around that, arbitrary properties are added. The keys must be unique, so they use BASIC-style line-numbering. Does anyone else remember BASIC? No? Ok, I must officially be old then. `composer validate` will complain about those properties, but normal commands won't, and they won't be automatically removed by `composer update`, etc. For our usage, they're practical, albeit hacky.
|
It didn't occur to me until this morning, but this seems like a better approach than the one we discussed in #152. |
|
Related: Seldaek/jsonlint#58 |
|
Ah, I found this buried in one of the many many many Composer issues complaining about this problem: Looks like |
|
Tested |
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.
Previously:
The JSON format does not allow comments because, in theory, it's only a data-exchange format. In reality, it's widely used in situations like this where comments are extremely important.
To work around that, arbitrary properties are added. The keys must be unique, so they use BASIC-style line-numbering. Does anyone else remember BASIC? No? Ok, I must officially be old then.
composer validatewill complain about those properties, but normal commands won't, and they won't be automatically removed bycomposer update, etc. For our usage, they're practical, albeit hacky.I also added some whitespace between the sections, because I find it much harder to visually parse a document when it's all crammed together.