Powershell二进制模块:动态选项卡补全Cmdlet参数值

本文关键字:Cmdlet 参数 选项 二进制 模块 动态 Powershell | 更新日期: 2023-09-27 18:17:38

我正在c#中编写二进制Powershell模块,我想要一个带有参数的Cmdlet,该参数提供动态的运行时选项卡完成。然而,我正在努力弄清楚如何在二进制模块中做到这一点。下面是我的尝试:

using System;
using System.Collections.ObjectModel;
using System.Management.Automation;
namespace DynamicParameterCmdlet
{
    [Cmdlet("Say", "Hello")]
    public class MyCmdlet : PSCmdlet
    {
        [Parameter, PSTypeName("string")]
        public RuntimeDefinedParameter Name { get; set; }
        public MyCmdlet() : base() {
            Collection<Attribute> attributes = new Collection<Attribute>() {
                new ParameterAttribute()
            };
            string[] allowedNames = NameProvider.GetAllowedNames();
            attributes.Add(new ValidateSetAttribute(allowedNames));
            Name = new RuntimeDefinedParameter("Name", typeof(string), attributes);
        }
        protected override void ProcessRecord()
        {
            string name = (string)Name.Value;
            WriteObject($"Hello, {Name}");
        }
    }
    public static class NameProvider
    {
        public static string[] GetAllowedNames()
        {
            // Hard-coded array here for simplicity but imagine in reality this
            // would vary at run-time
            return new string[] { "Alice", "Bob", "Charlie" };
        }
    }
}

这行不通。我没有得到任何选项卡完成功能。我还得到一个错误:

PS > Say-Hello -Name Alice
Say-Hello : Cannot bind parameter 'Name'. Cannot convert the "Alice" value of type "System.String" to type "System.Management.Automation.RuntimeDefinedParameter".
At line:1 char:17
+ Say-Hello -Name Alice
+                 ~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Say-Hello], ParameterBindingException
    + FullyQualifiedErrorId : CannotConvertArgumentNoMessage,DynamicParameterCmdlet.MyCmdlet

我找到了一篇文章,其中有一个如何在非二进制Powershell模块中做到这一点的示例。似乎在非二进制模块中,您包括DynamicParam,然后是构建和返回RuntimeParameterDictionary对象的语句。基于这个例子,我希望在PSCmdlet类中有一个等价的,也许是一个可重写的GetDynamicParameters()方法或类似的东西,就像有一个可重写的BeginProcessing()方法一样。

按照这个速度,二进制模块在Powershell世界中似乎是二等公民。肯定有我错过的办法吧?

Powershell二进制模块:动态选项卡补全Cmdlet参数值

下面是在PowerShell v5中实现自定义参数补全的方法:

Add-Type @‘
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.Linq;
    using System.Management.Automation;
    using System.Management.Automation.Language;
    [Cmdlet(VerbsDiagnostic.Test,"Completion")]
    public class TestCompletionCmdlet : PSCmdlet {
        private string name;
        [Parameter,ArgumentCompleter(typeof(NameCompleter))]
        public string Name {
            set {
                name=value;
            }
        }
        protected override void BeginProcessing() {
            WriteObject(string.Format("Hello, {0}", name));
        }
        private class NameCompleter : IArgumentCompleter {
            IEnumerable<CompletionResult> IArgumentCompleter.CompleteArgument(string commandName,
                                                                              string parameterName,
                                                                              string wordToComplete,
                                                                              CommandAst commandAst,
                                                                              IDictionary fakeBoundParameters) {
                return GetAllowedNames().
                       Where(new WildcardPattern(wordToComplete+"*",WildcardOptions.IgnoreCase).IsMatch).
                       Select(s => new CompletionResult(s));
            }
            private static string[] GetAllowedNames() {
                return new string[] { "Alice", "Bob", "Charlie" };
            }
        }
    }
’@ -PassThru|Select-Object -First 1 -ExpandProperty Assembly|Import-Module

你特别需要:

  • 实现IArgumentCompleter接口实现这个接口的类应该有一个公共的默认构造函数。
  • ArgumentCompleterAttribute属性应用于字段的属性,用作cmdlet参数。作为属性的参数,应该传递IArgumentCompleter实现。
  • IArgumentCompleter.CompleteArgument你有wordToComplete参数,所以你可以过滤完成选项的文本,已经由用户输入。

试一下:

Test-Completion -Name Tab