PowerShell / PowerShell/PSScriptAnalyzer

UseShouldProcessForStateChangingFunctions should prove that a function changes system state.

未關閉
#206 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Issue - Bug Issue - New Rule Up-for-Grabs
主要語言
C#
星號
2.2k
分支
414
平均合併
13 小時 1 分鐘
30 天內合併 PR
2

描述

Right now, the UseShouldProcessForStateChangingFunctions rule only looks at the name of the function (the verb) in order to determine that the function changes system state.

I think the rule should look at the body of the function and see if the function uses other functions that changes system state before it issues a warning.

If not, then I think that functions with the "New" verb should not be considered as functions that change system state. A lot of functions from the community with the "New" verb do not change system state, but are actually just different forms of "New-Object". See, for example, the ShowUI module.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 UseShouldProcessForStateChangingFunctions 規則開始,追蹤它目前如何使用函式名稱來發出警告。調查該規則如何檢查函式主體和函式呼叫,包括在 New-verb 函式不會變更系統狀態時是否應將其排除在外。完成的標準是:該規則能夠區分會變更狀態的函式和物件建構函式,而不只依賴動詞。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp, powershell
領域
devtools
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。