PowerShell / PowerShell/PSScriptAnalyzer
Allow modules to provide rules
まだ誰も着手していません。
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
Summary of the new feature
as a user/developer I would like to have rules be defined as a part of a module.
As it stands now, the only possibility i can see right now to import "custom" rules is via CustomRulePath, however documentation and testing leads me to believe this only supports a known static or relative path.
Proposed technical implementation details (optional)
As a part of your documentation you talk about MEF, but this is possibly only for CustomRulePath? I can see as part of instance that you have ValidModPaths, but it seemes to only have data appended by methods in reference to GetValidCustomRulePaths()?
- checking all commands in psmodulepath that outputs
Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord?- Alternativly you could have the module require to have psdata.ExternalModuleDependencies defined to scriptanalyzer?
- alternativly you can add
usingModulesto settings so you dont need to re-check all modules in current runspace, but just the ones defined by the user
I want Scriptanalyzer to also check available rules from modules.
What is the latest version of PSScriptAnalyzer at the point of writing
1.24.0
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、文書化されている CustomRulePath と MEF の動作を確認し、次に ValidModPaths と GetValidCustomRulePaths() を調べて、現在のカスタム ルールの検出方法を理解します。モジュールの検出または構成に関する意図されたアプローチを明確にし、利用可能なモジュール ルールを DiagnosticRecord の実装としてどのように認識するかを定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- powershell
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100