Context and request
The data-module verb vocabulary includes Remove-<Noun>Entry for removing elements by criteria, and PSModule/Hashtable ships Remove-HashtableEntry as the reference implementation. Json has no equivalent, so a user stripping secrets, null values, or empty collections before writing a document out has to walk the object graph by hand.
Acceptance criteria.
Remove-JsonEntry removes entries from a JSON document by key name and by criteria such as null values and empty collections.- Removal applies recursively through nested objects and through objects inside arrays.
- The input is not mutated; the command returns a new structure.
- It declares
[OutputType()] with matching .OUTPUTS, and carries complete comment-based help with a .LINK to https://psmodule.io/Json/Functions/Remove-JsonEntry/.
- Behaviour matches
Remove-HashtableEntry wherever the operation is analogous.
- Tests cover key removal, recursive removal, removal inside arrays, null and empty-collection criteria, non-existent keys, and confirmation that the input is unchanged. Coverage stays at or above the 95% target.
Technical decisions
Study Remove-HashtableEntry's parameter names and criteria before designing this. The two commands should agree on what "remove an entry" means, so a user moving between the modules is not surprised.
Non-mutation is a hard requirement. Import-Json returns live objects that a caller may still hold a reference to, and a command that quietly rewrote them in place would be a worse version of the _SourceFile defect this module is already correcting.
Whether this needs SupportsShouldProcess is worth a moment's thought and should be recorded either way. It transforms an in-memory object rather than persisting anything, and the standard reserves ShouldProcess for state changes — so the answer is probably no, but it should be a decision rather than an oversight.
Depth is a parameter from the outset, consistent with the other traversal commands.
Depends on the function-standard work landing first so this is written against the corrected patterns.
Implementation plan
Context and request
The data-module verb vocabulary includes
Remove-<Noun>Entryfor removing elements by criteria, andPSModule/HashtableshipsRemove-HashtableEntryas the reference implementation.Jsonhas no equivalent, so a user stripping secrets, null values, or empty collections before writing a document out has to walk the object graph by hand.Acceptance criteria.
Remove-JsonEntryremoves entries from a JSON document by key name and by criteria such as null values and empty collections.[OutputType()]with matching.OUTPUTS, and carries complete comment-based help with a.LINKtohttps://psmodule.io/Json/Functions/Remove-JsonEntry/.Remove-HashtableEntrywherever the operation is analogous.Technical decisions
Study
Remove-HashtableEntry's parameter names and criteria before designing this. The two commands should agree on what "remove an entry" means, so a user moving between the modules is not surprised.Non-mutation is a hard requirement.
Import-Jsonreturns live objects that a caller may still hold a reference to, and a command that quietly rewrote them in place would be a worse version of the_SourceFiledefect this module is already correcting.Whether this needs
SupportsShouldProcessis worth a moment's thought and should be recorded either way. It transforms an in-memory object rather than persisting anything, and the standard reservesShouldProcessfor state changes — so the answer is probably no, but it should be a decision rather than an oversight.Depth is a parameter from the outset, consistent with the other traversal commands.
Depends on the function-standard work landing first so this is written against the corrected patterns.
Implementation plan
Remove-HashtableEntry's parameters and criteriaShouldProcessquestionsrc/functions/public/Remove-JsonEntry.ps1with[OutputType()], full comment-based help, and a-DepthparameterGet-Command -Module Jsonand its reference page generates