PowerShell / PowerShell/PSScriptAnalyzer
Whitespace Between Parameters Is Trimming Required Quotes
オープン
まだ誰も着手していません。
Area - Formatter
Issue - Bug
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
- ✅ Make sure you are able to repro it on the latest released version
- ✅ Perform a quick search for existing issues to check if this bug has already been reported.
- Might be related to #1540
This was one of the more simple examples I could find.
I found this issue popping up in random files and finally realized it was a formatter issue.
Steps to reproduce
Describe "DescribeName" {
Context "ContextName" {
It "ItName" {
Assertion
}
It "output: attributes matches $($outputs.attributes)" {
$results.attributes | Should -Be $outputs.attributes
}
}
}
Expected behavior
Describe "DescribeName" {
Context "ContextName" {
It "ItName" {
Assertion
}
It "output: attributes matches $($outputs.attributes)" {
$results.attributes | Should -Be $outputs.attributes
}
}
}
Actual behavior
Describe "DescribeName" {
Context "ContextName" {
It "ItName" {
Assertion
}
It "output: attributes matches $($outputs.attributes){ <----- it removed valid quote, resulting in breaking syntax
$results.attributes | Should -Be $outputs.attributes
}
}
}
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 7.0.3
PSEdition Core
GitCommitId 7.0.3
OS Darwin 19.5.0 Darwin Kernel Version 19.5.0: Tue May 26 20:41:44 PDT 2020; root:xnu-6153.121.2~2/RELEASE_X86_64
Platform Unix
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.19.0
1.18.3
1.19.1
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、記載されている PSScriptAnalyzer のバージョンを使用して、issue の PowerShell の例で formatter の問題を再現します。引用符で囲まれた It 文字列のフォーマット処理を追跡し、必要な空白と引用符に対する回帰テストを追加します。完了の条件は、フォーマット処理によって閉じ引用符が保持され、結果が有効な PowerShell 構文のままであることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- powershell
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100