PowerShell / PowerShell/PSScriptAnalyzer
Rule request: `Get-Content x | ConvertFrom-Json` should suggest adding `-raw` for `Get-content`
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Summary of the new feature
When you call get-content file.json | convertfrom-json, funny things happen when file.json contains a comment at the top of the file.
Multiple places suggest that it's better to use get-content -raw for performance and predictability.
See:
- https://github.com/PowerShell/PowerShell/issues/12229
- https://stackoverflow.com/questions/71025659/set-property-value-on-object-loaded-from-json-containing-comments
Proposed technical implementation details (optional)
When get-content is piped to convertfrom-*, PSScriptAnalyzer should suggest adding -raw to get-content.
The same could apply to [xml] get-content file.xml.
What is the latest version of PSScriptAnalyzer at the point of writing
1.21
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named. Start by reviewing existing PSScriptAnalyzer rules for Get-Content piped to ConvertFrom-* and the linked PowerShell issue; determine the intended handling for JSON comments and the possible XML case. Done means the analyzer consistently suggests -Raw where appropriate and the behavior is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- devtools, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100