PowerShell / PowerShell/PSScriptAnalyzer
Remove-Module PSScriptAnalyzer leaves behavior of removed module version
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Removing a version of PSScriptAnalyzer does not remove its behavior from the session. I don't know much about this, but it looks like we're missing code to clean up after a remove.
Version 1.10.0 and 1.11.0 are somewhat different. For example, in 1.11.0, the Settings parameter tab-completes the .psd1 file names in the Settings subdirectory. Also, the PSPlaceOpenBrace and PSPlaceCloseBrace rules do not trigger on a one-line function, such as:
function Test-Brace1 () {"Hello, World"}
However, if you import one version (Import-Module), remove that version (Remove-Module), and then import the other version, the result is the same as if you imported only the first version.
This is important, because the results of the different module versions are perceptibly different.
REPRO:
0. Start a new session, e.g. new console.
1. ipmo PSScriptAnalyzer -RequiredVersion 1.10.0 -Passthru
2. gmo | rmo
3. ipmo PSScriptAnalyzer -RequiredVersion 1.11.0 -Passthru
Now, test one of the differing features.
4. Invoke-ScriptAnalyzer -Settings <TAB> #Fails to tab complete, as in 1.10.0.
5. Invoke-ScriptAnalyzer -ScriptDefinition 'function Test-Brace1 () {"Hello, World"}' -Settings $home\Documents\WindowsPowerShell\Modules\PSScriptAnalyzer\1.11.0\Settings\CodeFormatting.psd1
This returns output that you shouldn't see any more in 1.11.0.
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSPlaceOpenBrace Warning 1 There is no new line after open brace.
PSPlaceCloseBrace Warning 1 Close brace is not on a new line.
The same is true if you reverse the order of the versions.
0. Start a new session, e.g. new console.
1. ipmo PSScriptAnalyzer -RequiredVersion 1.11.0 -Passthru
2. gmo | rmo
3. ipmo PSScriptAnalyzer -RequiredVersion 1.10.0 -Passthru
Now, we have 1.10.0 with 1.11.0 behavior:
4. Invoke-ScriptAnalyzer -Settings <TAB> #Tab completes!
5. Invoke-ScriptAnalyzer -ScriptDefinition 'function Test-Brace1 () {"Hello, World"}' -Settings CodeFormatting
Version 1.10.0 should error on the one-liner, but it doesn't.
PS C:\> Invoke-ScriptAnalyzer -Settings CodeFormatting -ScriptDefinition 'function Test-Brace1 () {"Hello, World"}'
PS C:\>
Strange, I know. If you need more info, let me know. Thanks!
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
Start with the Import-Module and Remove-Module sequence in the reproduction, then inspect the Invoke-ScriptAnalyzer behavior after switching between PSScriptAnalyzer 1.10.0 and 1.11.0. Compare settings tab completion and the PSPlaceOpenBrace and PSPlaceCloseBrace results; done means removing one version no longer leaves its behavior in the session.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100