Рекомендации по именованию командлетов Powershell - PullRequest
0 голосов
/ 13 февраля 2020

У меня есть процесс развертывания, который включает в себя запутывание некоторых файлов перед их доставкой клиенту, для этого он вызывает пользовательский C# командлет с именем Get-ObfuscateScripts.

. было бы наилучшим методом именования для таких пользовательских командлетов, на мой взгляд, идеальное имя в этом случае было бы Obfuscate-Scripts, но это выдает мне предупреждающее сообщение:

WARNING: The names of some imported commands from the 'xxxxxxxx' include unapproved verbs that might make them less discoverable. To find the commands with unapproved verbs, run the Import-Module com
mand again with the Verbose parameter. For a list of approved verbs, type Get-Verb.

Я действительно не понимаю смысл этого сообщения, если я переименую его в что-то вроде, скажем, Invoke-ObfuscateScripts, будет ли intellisense работать лучше на Powershell ISE или что-то в этом роде? Или это просто говорит о том, что я должен ожидать, что опытные пользователи Powershell будут всегда использовать API, сначала изучая утвержденные глаголы?

1 Ответ

1 голос
/ 13 февраля 2020

Технически PowerShell не заботится о том, что вы называете своими функциями / командлетами, но рекомендуется следовать рекомендованным стандартам именования, чтобы пользователи могли легче понять, что делает ваш командлет, просто по названию. Например, рекомендуется использовать «get» вместо «query», «lookup», «read» и т. Д. c.

Имя должно быть в формате «глагол-существительное», используя только глаголы, перечисленные здесь:

Одобренные глаголы

В вашем случае, похоже, «Protect» / «Unprotect» - лучший вариант.

Существительная часть не прописана таким же образом, но должна быть в единственном числе. Вот почему, например, у нас есть Get-Process, а не Get-Processes, et c. В вашем случае это может быть просто «скрипт».

Итак, одна возможность для вашего командлета - Protect-Script

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...