PowerShell / PowerShell/PSScriptAnalyzer

UseCompatibleCommands should recognise partial parameter matches

未关闭
#1,201 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area - Rules Issue - Enhancement
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

Summary of the new feature

PowerShell allows for the usage of partial parameter names, like Import-Module 'MyModule' -Pass.

UseCompatibleCommands currently sees this is a compatibility error.

While PSScriptAnalyzer should discourage truncated parameter names (like command aliases), UseCompatibleCommands should be able to recognise the difference between a truncated parameter that will work and something that will not.

Proposed technical implementation details (optional)

The query API currently uses a dictionary to look up parameters. Instead of this, it should lazily compute a trie of parameters that is able to tell whether a parameter is uniquely resolved given an input.

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

1.18.0

/cc @JamesWTruher

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先跟踪 UseCompatibleCommands 及其查询 API,以找到当前基于字典的参数查找逻辑。检查 PowerShell 部分参数名称的分类方式,然后验证对于能够唯一解析的缩写以及有歧义或无效的缩写,其行为是否符合预期。完成标准是接受有效的部分匹配,同时不削弱 analyzer 现有的兼容性检查。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, powershell
领域
tooling
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。