Compartilhar via

Import-IseSnippet

Módulo:
ISE Module

Importa snippets do ISE para a sessão atual

Sintaxe

FromFolder (Padrão) 

Import-IseSnippet
    [-Path] <String>
    [-Recurse]
    [<CommonParameters>]

FromModule 

Import-IseSnippet
    -Module <String>
    [-Recurse]
    [-ListAvailable]
    [<CommonParameters>]

Description

O cmdlet Import-IseSnippet importa "snippets" de texto reutilizáveis de um módulo ou de um diretório para a sessão atual. Os snippets estão imediatamente disponíveis para uso no ISE do Windows PowerShell. Esse cmdlet funciona apenas no ISE (Ambiente de Script Integrado) do Windows PowerShell.

Para exibir e usar os snippets importados, no menu Editar do ISE do Windows PowerShell, clique em Iniciar Snippets ou pressione Ctrl+J.

Snippets importados estão disponíveis apenas na sessão atual. Para importar os snippets em todas as sessões ISE do Windows PowerShell, adicione um comando Import-IseSnippet ao seu perfil do Windows PowerShell ou copie os arquivos de snippet para o diretório de snippets locais $HOME\Documents\WindowsPowerShell\Snippets.

Para importar snippets de código, eles devem ser formatados corretamente nos snippets de snippet de código XML do ISE do Windows PowerShell e salvos em arquivos Snippet.ps1xml. Para criar snippets qualificados, use o cmdlet New-IseSnippet. New-IseSnippet cria um arquivo <SnippetTitle>.Snippets.ps1xml no diretório $HOME\Documents\WindowsPowerShell\Snippets. Você pode mover ou copiar os snippets para o diretório Snippets de um módulo do Windows PowerShell ou para qualquer outro diretório.

O cmdlet Get-IseSnippet, que obtém snippets criados pelo usuário no diretório de snippets locais, não obtém snippets importados.

Esse cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: importar snippets de um diretório

Este exemplo importa os snippets do diretório \\Server01\Public\Snippets para a sessão atual. Ele usa o parâmetro Recurse para obter snippets de todos os subdiretórios do diretório Snippets.

Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse

Exemplo 2: importar snippets de um módulo

Este exemplo importa os snippets do módulo SnippetModule. O comando usa o parâmetro ListAvailable para importar os snippets, mesmo que o módulo snippetModule não seja importado para a sessão do usuário quando o comando for executado.

Import-IseSnippet -Module SnippetModule -ListAvailable

Exemplo 3: localizar snippets em módulos

Este exemplo obtém snippets em todos os módulos instalados na variável de ambiente PSModulePath.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$_.FullName}

Exemplo 4: Importar todos os snippets de módulo

Este exemplo importa todos os snippets de todos os módulos instalados para a sessão atual. Normalmente, você não precisa executar um comando como este porque os módulos que têm snippets de código usarão o cmdlet Import-IseSnippet para importá-los para você quando o módulo for importado.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$psISE.CurrentPowerShellTab.Snippets.Load($_)}

Exemplo 5: Copiar todos os snippets de módulo

Este exemplo copia os arquivos de snippet de todos os módulos instalados no diretório Snippets do usuário atual. Ao contrário dos snippets importados, que afetam apenas a sessão atual, os snippets copiados estão disponíveis em todas as sessões ISE do Windows PowerShell.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    Copy-Item -Destination $HOME\Documents\WindowsPowerShell\Snippets

Parâmetros

-ListAvailable

Indica que esse cmdlet obtém snippets de módulos instalados no computador, mesmo que os módulos não sejam importados para a sessão atual. Se esse parâmetro for omitido e o módulo especificado pelo parâmetro Module não for importado para a sessão atual, a tentativa de obter os snippets do módulo falhará.

Esse parâmetro é válido somente quando o parâmetro módulo é usado no comando.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

FromModule
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Module

Importa snippets do módulo especificado para a sessão atual. Não há suporte para caracteres curinga.

Esse parâmetro importa snippets de Snippet.ps1xml arquivos no subdiretório Snippets no caminho do módulo, como $HOME\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Esse parâmetro foi projetado para ser usado por autores de módulo em um script de inicialização, como um script especificado no ScriptsToProcess chave de um manifesto do módulo. Os snippets em um módulo não são importados automaticamente com o módulo, mas você pode usar um comando Import-IseSnippet para importá-los.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

FromModule
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Path

Especifica o caminho para o diretório snippets no qual esse cmdlet importa snippets.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:True
DontShow:False

Conjuntos de parâmetros

FromFolder
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Recurse

Indica que esse cmdlet importa snippets de todos os subdiretórios do valor do parâmetro caminho.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Não é possível transferir objetos para esse cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

  • Você não pode usar o cmdlet Get-IseSnippet para obter snippets importados. Get-IseSnippet obtém apenas snippets no diretório $HOME\Documents\WindowsPowerShell\Snippets.

  • Import-IseSnippet usa o método estático Load de objetos Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Você também pode usar o método Load de snippets no modelo de objeto ISE do Windows PowerShell: $psISE.CurrentPowerShellTab.Snippets.Load()

  • O cmdlet New-IseSnippet armazena novos snippets criados pelo usuário em arquivos de .ps1xml sem sinal. Dessa forma, o Windows PowerShell não pode carregá-los em uma sessão na qual a política de execução é AllSigned ou Restricted. Em uma sessão Restricted ou AllSigned, você pode criar, obter e importar snippets não assinados criados pelo usuário, mas não é possível usá-los na sessão.

    Para usar snippets não assinados criados pelo usuário que o cmdlet Import-IseSnippet retorna, altere a política de execução e 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.