GeezerVison is showing github.com — Refactor New-CommandDataFile script by sdwheeler · Pull Request #2197 · PowerShell/PSScriptAnalyzer
Conversation
Refactor New-CommandDataFile script
This PR rewrites the script to create a function and fixes several issues:
- Adds comment-based help
- Adds parameter to specify an output path for the JSON file
- Fixes the logic to avoid duplicate data output
- Outputs a FileInfo object for the newly created file
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Refactors Utils/New-CommandDataFile.ps1 into an advanced script/function that generates the command/alias JSON data file used for compatibility-related settings, adding an OutputPath parameter and modernizing the implementation.
Changes:
- Converts the script logic into an advanced function (
New-CommandDataFile) and calls it from the script entrypoint.
- Adds
OutputPath support and uses module-qualified cmdlet invocations throughout.
- Reworks module/command/alias enumeration and JSON emission.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Changes recommended
Help is attached to the inaccessible nested function, input validation accepts files, and failed writes can return stale output.
Get a fresh assessment by requesting another Copilot review.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Balanced
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
|
[OutputType([System.IO.FileInfo])]
|
|
|
[CmdletBinding()]
|
|
|
param(
|
|
|
[ValidateScript({ Test-Path $_ })]
|
|
|
$aliases = $aliases.Name
|
|
|
$jsonData |
|
|
|
Microsoft.PowerShell.Utility\ConvertTo-Json -Depth 4 |
|
|
|
Microsoft.PowerShell.Utility\Out-File $outputFileName -Encoding utf8
|
Comment on lines
+7
to
+8
|
|
function New-CommandDataFile {
|
|
|
<#
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
happy with it but what is the context if you can share? the files shipped with PSSA and produced by this command are many years old btw and probably need updating as they are also powershell version specific. as no one has complained, don't think the rule that uses them is used a lot (which makes sense given that the new compat rules from rob are much better)
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
Christoph Bergmeister (bergmeister)
left a comment