allow unused tags to be kept #1647
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
DerManoMann
requested changes
Aug 27, 2024
src/Processors/AugmentTags.php
Outdated
| @@ -15,6 +15,22 @@ | |||
| */ | |||
| class AugmentTags implements ProcessorInterface | |||
| { | |||
|
|
|||
| /** @var array<string> */ | |||
| protected $unusedTagsToKeepWhitelist = []; | |||
There was a problem hiding this comment.
Suggested change
| protected $unusedTagsToKeepWhitelist = []; | |
| protected $unusedTagsToKeepWhitelist; |
I think the other processors only intialize in the constructor and that should be enough.
There was a problem hiding this comment.
based it off CleanUnusedComponents, makes sense to only do it in one spot though.
src/Processors/AugmentTags.php
Outdated
| /** @var array<string> */ | ||
| protected $unusedTagsToKeepWhitelist = []; | ||
|
|
||
| public function __construct(array $unusedTagsToKeepWhitelist = []) |
There was a problem hiding this comment.
Suggested change
| public function __construct(array $unusedTagsToKeepWhitelist = []) | |
| public function __construct(array $whitelist = []) |
It think this should be meaningful enough? This class is all about tags, after all.
src/Processors/AugmentTags.php
Outdated
| @@ -48,8 +65,10 @@ public function __invoke(Analysis $analysis) | |||
| } | |||
| } | |||
|
|
|||
| // remove tags that we don't want to keep (defaults to all unused tags) | |||
| $tagsToKeep = array_merge($usedTagNames, $this->unusedTagsToKeepWhitelist); | |||
There was a problem hiding this comment.
Could there be a special case of '*' which would keep all tags?
src/Processors/AugmentTags.php
Outdated
| $this->unusedTagsToKeepWhitelist = $unusedTagsToKeepWhitelist; | ||
| } | ||
|
|
||
| public function setUnusedTagsToKeepWhitelist(array $unusedTagsToKeepWhitelist): AugmentTags |
There was a problem hiding this comment.
Suggested change
| public function setUnusedTagsToKeepWhitelist(array $unusedTagsToKeepWhitelist): AugmentTags | |
| /** | |
| * Whitelist tags to keep even if not used. <code>*</code> may be used to keep all unused. | |
| */ | |
| public function setUnusedTagsToKeepWhitelist(array $unusedTagsToKeepWhitelist): AugmentTags |
The docblock on the setXXX() method is used to auto-generate the processor reference, so adding something here would be good.
DerManoMann
approved these changes
Sep 22, 2024
|
Thanks @pauljohnston2009 |
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.
The changes in #1625 mean that we cannot have descriptive tags that do not have a reference to them from an operation. It is nice to allow this so we can have pages dedicated to be informative only (and allow external links directly to that section in the page).
eg. tags like