Code Formatter: Don't remove module names from cmdlet calls

[markdomansky]

Prerequisites

• [X] I have written a descriptive issue title.
• [X] I have searched all issues to ensure it has not already been reported.

Summary

Currently, with the code formatter, if you have a cmdlet call such as MicrosoftTeams\Get-CsLisCivicAddress, and run the formatter, it will remove the module name resulting in Get-CsLisCivicAddress. Including the module name gives specificity with clobbered cmdlets, as in my case. Get-CsLisCivicAddress is a valid function in two different modules.

As I understand it, including the module name in functions/modules is actually a best practice.

I've been through all the code formatting settings and none seem to relate to the above experience, including 'Auto Correct Aliases'. Disabling this did not change the behavior.

Proposed Design

At a minimum, I would like an option to enable/disable this, perhaps "Auto Remove Module Name from Cmdlets".

Even better would be expanding this to automatically add the module name to cmdlets when possible. So writing Get-CsLisCivicAddress would be converted to MicrosoftTeams\Get-CsLisCivicAddress. The option could be a drop down with Remove/Do Nothing/Add.

[JustinGrote]

Thanks for the submission! Most of the "refactors" for the code formatter are actually currently provided by PSScriptAnalyzer, can you verify that this isn't specific to PSScriptAnalyzer? If it is then it needs to be handled there.

[markdomansky]

I'm unable to reproduce with Invoke-ScriptAnalyzer -path test.ps1 (with or without -fix). It doesn't change the file and doesn't throw any output.

VSCode also does not list it as a Problem in the UI but only fixes it during formatting.

[JustinGrote]

So I can't reproduce using either "Format Document", "Format on Paste", or "Format on Save"

$x = Microsoft.PowerShell.Management\Get-Service -Name 'wuauserv'
$x.status

This does not get shortened to Get-Service

Can you provide a reproducible example? Maybe record a gif using something like ScreenToGif?

EDIT: Apologies, it appears your use case is when there is a specific clobber conflict. My guess is what's happening is the normal module resolve is happening and not realizing you have two cmdlets for whatever reason, so I agree this should defer to the fully qualified and have a option checkbox for whether to preserve fully qualified or shorten if possible. I haven't looked at the code that actually does this work, maybe @andyleejordan or @SeeminglyScience have more input.

[markdomansky]

Here's the screen cap. As it shows, the only module that I can find affected is MicrosoftTeams (though I certainly haven't tested all modules). It also shows PSSA is working with the Problems tab pulled up.

To be clear, this isn't specifically a clobbering issue, that was just how I encountered it. In this case, the Get-CsOnlineLisCivicAddress cmdlet only exists in one module (though I have 2 versions, only 1 is loaded. Pester and PowerShellGet both have multiple versions but are not affected).

I honestly have no idea why just the MicrosoftTeams module is affected. I don't have any snippets or anything I'm aware of that I've done that would cause this.