Skip to content

Need a rule to warn when overriding core cmdlets #1024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rjmholt opened this issue Jun 13, 2018 · 1 comment
Closed

Need a rule to warn when overriding core cmdlets #1024

rjmholt opened this issue Jun 13, 2018 · 1 comment

Comments

@rjmholt
Copy link
Contributor

rjmholt commented Jun 13, 2018

Summary of the new feature

Followup from PowerShell/PowerShellEditorServices#686 (review).

Some users have had problems starting PSES because other modules override core cmdlets (in the above case, Set-Content is redefined...). We can't prevent it, but ideally module authors should get a stern warning!

In user story terms:

As a module/script author, I want to be warned when I'm redefining core cmdlets
so that my module/script is less likely to interfere with/break other PowerShell modules when installed.

Proposed technical implementation details

The rule should probably lazily cache all the cmdlet names in the following core modules:

  • Microsoft.PowerShell.Core
  • Microsoft.PowerShell.Management
  • Microsoft.PowerShell.Utility
  • PSReadLine
  • Microsoft.PowerShell.Diagnostics
  • Microsoft.PowerShell.Host
  • Microsoft.PowerShell.Security
  • Microsoft.PowerShell.Archive
  • Microsoft.WSMan.Management
  • PowerShellGet?

An ideal implementation probably has a default list of modules, which can be changed or added to.

The simplest way to do this is to read the module manifest or run Get-Module <module> | Select-Object ExportedCommands.

In the case where an author wants to prevent redefining cmdlets in a module they don't have installed at analysis time, I'm not entirely sure what the correct solution is, but can't imagine the problem being insoluble.

What is the latest version of PSScriptAnalyzer at the point of writing

1.17.1

@rjmholt
Copy link
Contributor Author

rjmholt commented Jun 13, 2018

Closing in favour of #1023

@rjmholt rjmholt closed this as completed Jun 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant