Compartilhar via

New-IseSnippet

  • Referência
Módulo:
ISE

Cria um snippet de código do ISE do Windows PowerShell.

Sintaxe

New-IseSnippet
   [-Title] <String>
   [-Description] <String>
   [-Text] <String>
   [-Author <String>]
   [-CaretOffset <Int32>]
   [-Force]
   [<CommonParameters>]

Description

O New-ISESnippet cmdlet cria um "snippet" de texto reutilizável para o ISE do Windows PowerShell. Você pode usar snippets para adicionar texto ao painel Script ou painel Comando no ISE do Windows PowerShell. Este cmdlet está disponível apenas no ISE do Windows PowerShell.

A partir do Windows PowerShell 3.0, o ISE do Windows PowerShell inclui uma coleção de snippets internos. O New-ISESnippet cmdlet permite que você crie seus próprios snippets para adicionar à coleção interna. Você pode exibir, alterar, adicionar, excluir e compartilhar arquivos de snippet e incluí-los em módulos do Windows PowerShell. Para ver snippets no ISE do Windows PowerShell, no menu Editar, selecione Iniciar Snippets ou pressione CTRL+J.

O New-ISESnippet cmdlet cria um <Title>.Snippets.ps1xml arquivo no $HOME\Documents\WindowsPowerShell\Snippets diretório com o título especificado. Para incluir um arquivo de snippet em um módulo que você está criando, adicione o arquivo de snippet a um subdiretório Snippets do seu diretório do módulo.

Você não pode usar snippets criados pelo usuário em uma sessão na qual a política de execução é Restrita ou AllSigned.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Criar um snippet de ajuda baseado em comentários

New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS

    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Este comando cria um snippet Comment-BasedHelp para o ISE do Windows PowerShell. Ele cria um arquivo chamado Comment-BasedHelp.snippets.ps1xml no diretório $HOME\Documents\WindowsPowerShell\SnippetsSnippets do usuário.

Exemplo 2: Criar um snippet obrigatório

$M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

Este exemplo cria um snippet chamado Obrigatório para o ISE do Windows PowerShell. O primeiro comando salva o texto do trecho na $M variável. O segundo comando usa o New-ISESnippet cmdlet para criar o snippet. O comando usa o parâmetro Force para substituir um trecho anterior com o mesmo nome.

Exemplo 3: Copiar um snippet obrigatório de uma pasta para uma pasta de destino

Copy-Item "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Esse comando usa o Copy-Item cmdlet para copiar o snippet obrigatório da pasta onde New-ISESnippet o coloca no compartilhamento de arquivos Server\Share.

Parâmetros

-Author

Especifica o autor do snippet. O campo autor aparece no arquivo de snippet, mas ele não aparece quando você clica no nome do snippet no ISE do Windows PowerShell.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-CaretOffset

Especifica o caractere do texto do trecho em que esse cmdlet coloca o cursor. Insira um número inteiro que representa a posição do cursor, com "1" representando o primeiro caractere de texto. O valor padrão, 0 (zero), posiciona o cursor imediatamente antes do primeiro caractere de texto. Este parâmetro não recua o texto do snippet.

Tipo:Int32
Cargo:Named
Valor padrão:0
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Description

Especifica uma descrição do snippet. O valor de descrição é exibido quando você clica no nome do snippet no ISE do Windows PowerShell. Este parâmetro é obrigatório.

Tipo:String
Cargo:2
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Indica que esse cmdlet substitui arquivos de snippet com o mesmo nome no mesmo local. Por padrão, New-ISESnippet não substitui arquivos.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Text

Especifica o valor de texto que é adicionado quando você seleciona o snippet. O texto do snippet é exibido quando você clica no nome desse snippet, no ISE do Windows PowerShell. Este parâmetro é obrigatório.

Tipo:String
Cargo:3
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Title

Especifica um título ou nome para o snippet. O título também nomeia o arquivo de snippet. Este parâmetro é obrigatório.

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você não pode canalizar objetos para esse cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

New-IseSnippet Armazena novos snippets criados pelo usuário em arquivos .ps1xml não assinados. Dessa forma, o Windows PowerShell não pode adicioná-los a uma sessão na qual a política de execução é AllSigned ou Restricted. Em uma sessão restrita ou AllSigned , você pode criar, obter e importar snippets criados por usuários não assinados, mas não pode usá-los na sessão.

Se você usar o New-IseSnippet cmdlet em uma sessão Restricted ou AllSigned , o snippet será criado, mas uma mensagem de erro será exibida quando o Windows PowerShell tentar adicionar o snippet recém-criado à sessão. Para usar o novo snippet (e outros snippets não assinados criados pelo usuário), altere a diretiva de execução e, em seguida, reinicie o ISE do Windows PowerShell.

Para obter mais informações sobre as políticas de execução do Windows PowerShell, consulte about_Execution_Policies.

  • Para alterar um snippet, edite-o. Você pode editar arquivos de snippet no painel Script do ISE do Windows PowerShell.
  • Para excluir um snippet adicionado, exclua o arquivo de snippet.
  • Você não pode excluir um snippet interno, mas pode ocultar todos os snippets internos usando o "$psise. Options.ShowDefaultSnippets=$false".
  • Você pode criar um snippet que tenha o mesmo nome de um snippet interno. Os dois snippets aparecem no menu de snippet, no ISE do Windows PowerShell.