PowerShell / PowerShell/PSScriptAnalyzer
Remove-Module PSScriptAnalyzer leaves behavior of removed module version
まだ誰も着手していません。
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
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!
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
再現手順の Import-Module と Remove-Module のシーケンスから始め、PSScriptAnalyzer 1.10.0 と 1.11.0 を切り替えた後の Invoke-ScriptAnalyzer の動作を調べます。設定のタブ補完と PSPlaceOpenBrace および PSPlaceCloseBrace の結果を比較します。どちらかのバージョンを削除しても、その動作がセッションに残らなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, powershell
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100