fix(*): add logic to better determine if a param is internal to Porter #1202
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.
What does this change
What issue does it fix
Now that Porter's list of internal parameters can grow beyond the classic "porter-debug", thanks to the handy parameter sources work, we needed a better way to track these so that they are hidden on
porter explain
, not eligible for generation inporter parameters generate
, etc.Notes for the reviewer
The approach in this fix is to designate parameters as internal via adding a standardized comment to the
$comment
field of the parameter's definition schema. This seemed a less fragile route than to try to manage a slice/map in memory. Are there any potential issue(s) with the approach used?Checklist
If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇♀️