feat(remove): Wrap controlled patterns in comment block #4
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
BREAKING CHANGE: Now has a head and trailing comment which creates a block of controlled patterns. Anything in the comment block will be re-written on each run of the script
| ? [`\n${startComment}`, ...sortedPatterns, endComment] | ||
| : []; | ||
|
|
||
| const outputPatterns = [...before, ...controlledPatterns, ...after] |
README.md
Outdated
|
|
||
| Prepended to the list of provided pattens at the bottom of the file, to indicate which patterns are being controlled programmatically. | ||
| Allows you to document the list of patterns that are being controlled programmatically. This helps provide context as to why/what is controlling certain patterns within a `.gitignore` file. Anything inside the comment block will be re-written on each run. |
There was a problem hiding this comment.
Do we need to document that this option is required if you want to be able to remove controlled patterns? Otherwise, this looks like it's merely cosmetic.
There was a problem hiding this comment.
Given there is a default comment you get the removal behaviour out of the box rather than an opt-in. There is no way to opt-out of the block style.
There was a problem hiding this comment.
Ah, gotcha. So should we make it mandatory? Right now it's ?string.
There was a problem hiding this comment.
Ignore me. I need more coffee.
Co-Authored-By: michaeltaranto <michael.taranto@gmail.com>
markdalgleish
approved these changes
Oct 23, 2018
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.
Supports removing controlled patterns from
.gitignore. The patterns are now written to the.gitignorefile inside a comment block. This block is re-written on every run of the script, so any manual changes to the patterns inside the block will be discarded on subsequent runs.