PowerShell / PowerShell/PSScriptAnalyzer

"Reserved prefixes" rule

オープン
#1,198 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Issue - New Rule Up-for-Grabs
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
2

説明

Summary of the new feature

A while ago, the PowerShell extension had an issue open on it because

Get-Help Get-AdUser -Online

and

Get-Help Get-AdFoo -Online

(note, Foo is used to make it obvious and I forget what the actual noun was)

Were not giving the same result...

As it turned out, its because Get-AdFoo was from a module from the Gallery... Where Get-AdUser comes from the inbox Active Directory module.

Personally, I think it's quite dodgy to overload such a crucial prefix like Ad and we should warn users that certain prefixes are used already in very critical modules.

Proposed technical implementation details (optional)

A rule that gives a warning that says "you probably shouldn't use this prefix because it's already used by X"

Or something to that effect.

What is the latest version of PSScriptAnalyzer at the point of writing

1.18.0

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

実装ファイルやテストは特定されていません。まず、既存の PSScriptAnalyzer ルールのエントリポイントを見つけ、PowerShell のコマンド名とモジュールがどのように表現されているかを確認してください。その後、予約済みプレフィックスの出典、警告の動作、受け入れ基準を明確にしてから、ルールを実装またはテストしてください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, powershell
領域
tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。