Форум программистов, компьютерный форум, киберфорум
iNNOKENTIY21
Войти
Регистрация
Восстановить пароль

PowerShell Snippets

Запись от iNNOKENTIY21 размещена 11.11.2025 в 10:15. Обновил(-а) iNNOKENTIY21 11.11.2025 в 12:35
Показов 7398 Комментарии 0

Модуль PowerShell 5.1+ : Snippets.psm1



У меня модуль расположен в пользовательской папке модулей, по умолчанию: \Documents\WindowsPowerShell\Modules\Snippets\

А в самом низу файла-профиля ($PROFILE) импорт модуля: Import-Module Snippets

В модуле, на сегодняшний день, четыре функции и псевдонимы к ним:
  • snip → Get-Snippet — для получения сниппета по имени: вводим snip пробел и начало имени сниппета, ctrl+space или tab для автодополнения и enter или Alt+s.
  • snipa → Add-Snippet — для добавления: snipa -Name 'd' -Value 'dir -force | fw Name'
  • snips → Set-Snippet — для редактирования (работает авто-дополнение) существующего: snips -Name 'd' -Value 'gps | sort ws -Descending | select -First 10'
  • snipr → Remove-Snippet — для удаления: snipr d # будет удалён сниппет с именем d

Авто-дополнение имени сниппета работает в: snip, Get-Snippet, snips, Set-Snippet, snipr и Remove-Snippet.

Горячие клавиши (Alt+s) для замены имени сниппета в строке ввода терминала на значение сниппета.
Набираем полное имя сниппета (без предваряющего snip авто-дополнение не работает), нажимаем Alt+s и вместо имени в строке ввода будет значение сниппета.

Сниппеты сохраняются в файл snippets.clixml рядом с файлом профиля.
По умолчанию если нет файла, создаётся с одним сниппетом по имени — h.

PowerShell
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
#Requires -Version 5.1
#Requires -Modules @{ ModuleName = 'PSReadLine' ; ModuleVersion = '2.3.3' }
 
# Snippets.psm1
# Импрот модуля с назначением горячих клавиш в профиле,
# строго после PSReadLine Options.
# Порядок ВАЖЕН!
<#
    $env:PSModulePath -split ';' |
    ? { $_ -like "$(Split-Path $PROFILE -Parent)\Modules" } |
    % { "$_\Snippets\Snippets.psm1" }
 
    Если где-то в профиле меняете режим PSReadLine
    (Set-PSReadLineOption -EditMode ...),
    держите этот вызов выше импорта вашего модуля — он сбрасывает биндинги.
#>
 
# Определяем путь к файлу сниппетов
$SnippetsPath = "$(Split-Path $PROFILE -Parent)\snippets.clixml"
 
# Если файла сниппетов не существует, создаём с дефолтным значением
if (-not (Test-Path -LiteralPath $SnippetsPath -PathType Leaf)) {
    @{
        h = "Справка:`nsnip h"
    } | Export-Clixml $SnippetsPath
}
 
# Получает сниппет по имени из файла
function Get-Snippet {
    param(
        [Parameter(Position = 0)]
        [string] $Name
    )
 
    if ($Name) {
        $Snippets = Import-Clixml -Path $SnippetsPath
        $Snippets[$Name]
    }
}
 
# Добавляет сниппет в файл
function Add-Snippet {
    param (
        [Parameter(Mandatory)]
        [string] $Name,
 
        [Parameter(Mandatory)]
        [object] $Value
    )
 
    $Snippets = Import-Clixml -Path $SnippetsPath
 
    if ($Snippets.ContainsKey($Name)) {
        Write-Warning "Snippet «$Name» уже существует!"
    } else {
        $Snippets.Add($Name, $Value)
        $Snippets | Export-Clixml -Path $SnippetsPath
        Write-Host "Snippet «$Name» добавлен." -ForegroundColor Green
    }
}
 
function Set-Snippet {
    param (
        [Parameter(Mandatory)]
        [string] $Name,
 
        [Parameter(Mandatory)]
        [object] $Value
    )
 
    $Snippets = Import-Clixml -Path $SnippetsPath
 
    if ($Snippets.ContainsKey($Name)) {
        $Snippets[$Name] = $Value
        $Snippets | Export-Clixml -Path $SnippetsPath
        Write-Host "Snippet «$Name» изменён." -ForegroundColor Green
    } else {
        Write-Warning "Snippet «$Name» не существует!"
    }
}
 
# Удаляет сниппет с укзанным именем
function Remove-Snippet {
    param(
        [Parameter(Mandatory)]
        [string] $Name
    )
 
    $Snippets = Import-Clixml -Path $SnippetsPath
 
    if ($Snippets.ContainsKey($Name)) {
        $Snippets.Remove($Name)
        $Snippets | Export-Clixml -Path $SnippetsPath
        Write-Host "Snippet «$Name» удалён." -ForegroundColor Yellow
    } else {
        Write-Warning "Snippet «$Name» не найден!"
    }
}
 
# Задаём псевдонимы
Set-Alias -Name snip -Value Get-Snippet -Option AllScope -Scope Global
Set-Alias -Name snipa -Value Add-Snippet -Option AllScope -Scope Global
Set-Alias -Name snips -Value Set-Snippet -Option AllScope -Scope Global
Set-Alias -Name snipr -Value Remove-Snippet -Option AllScope -Scope Global
 
# Регистрируем автодополнение параметра Name для функций:
# Get-Snippet, snip, Remove-Snippets, snipr, Set-Snippet, snips
$CompleterParams = @{
    CommandName = @(
        'Get-Snippet', 'snip'
        'Remove-Snippet', 'snipr'
        'Set-Snippet', 'snips'
    )
    ParameterName = 'Name'
    ScriptBlock = [ScriptBlock] {
        param (
            $commandName,
            $parameterName,
            $wordToComplete,
            $commandAst,
            $fakeBoundParams
        )
 
        (Import-Clixml -Path $SnippetsPath).Keys |
            Where-Object { $_ -like "$wordToComplete*" } |
            ForEach-Object {
                [System.Management.Automation.CompletionResult]::new(
                    $_,
                    $_,
                    'ParameterValue',
                    $_
                )
            }
    }
}
 
Register-ArgumentCompleter @CompleterParams 
 
# Назначаем сочетание клавиш «Alt+s» для замены имени сниппета, на его значение
Set-PSReadLineKeyHandler -Chord 'Alt+s' -ScriptBlock {
    param($key, $arg)
 
    # Получаем текущее состояние строки ввода
    $ast = $null
    $tokens = $null
    $errors = $null
    $cursor = $null
 
    [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState(
        [ref] $ast,
        [ref] $tokens,
        [ref] $errors,
        [ref] $cursor
    )
 
    # Находим токен (слово), которое находится прямо перед курсором
    $tokenToExpand = $tokens |
        Where-Object { $_.Extent.EndOffset -eq $cursor } |
        Select-Object -Last 1
 
    if ($tokenToExpand) {
        $snippetName = $tokenToExpand.Extent.Text
        $snippets = Import-Clixml -Path $SnippetsPath
 
        # Если сниппет с таким именем существует
        # Заменяем имя сниппета в строке ввода на его значение
        if ($snippets.ContainsKey($snippetName)) {
            $snippetValue = $snippets[$snippetName]
 
            $Offset = $tokenToExpand.Extent.StartOffset
            $Length = $tokenToExpand.Extent.Text.Length
 
            if ($tokenToExpand.Extent.StartOffset -gt 1) {
                $Length = $tokenToExpand.Extent.Text.Length + $Offset
                $Offset = 0
            }
 
            [Microsoft.PowerShell.PSConsoleReadLine]::Replace(
                $Offset,
                $Length,
                "$snippetValue"
            )
        }
    }
}
Размещено в PowerShell
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
Всего комментариев 0
Комментарии
 
Новые блоги и статьи
Новый ноутбук
volvo 07.12.2025
Всем привет. По скидке в "черную пятницу" взял себе новый ноутбук Lenovo ThinkBook 16 G7 на Амазоне: Ryzen 5 7533HS 64 Gb DDR5 1Tb NVMe 16" Full HD Display Win11 Pro
Музыка, написанная Искусственным Интеллектом
volvo 04.12.2025
Всем привет. Некоторое время назад меня заинтересовало, что уже умеет ИИ в плане написания музыки для песен, и, собственно, исполнения этих самых песен. Стихов у нас много, уже вышли 4 книги, еще 3. . .
От async/await к виртуальным потокам в Python
IndentationError 23.11.2025
Армин Ронахер поставил под сомнение async/ await. Создатель Flask заявляет: цветные функции - провал, виртуальные потоки - решение. Не threading-динозавры, а новое поколение лёгких потоков. Откат?. . .
Поиск "дружественных имён" СОМ портов
Argus19 22.11.2025
Поиск "дружественных имён" СОМ портов На странице: https:/ / norseev. ru/ 2018/ 01/ 04/ comportlist_windows/ нашёл схожую тему. Там приведён код на С++, который показывает только имена СОМ портов, типа,. . .
Сколько Государство потратило денег на меня, обеспечивая инсулином.
Programma_Boinc 20.11.2025
Сколько Государство потратило денег на меня, обеспечивая инсулином. Вот решила сделать интересный приблизительный подсчет, сколько государство потратило на меня денег на покупку инсулинов. . . .
Ломающие изменения в C#.NStar Alpha
Etyuhibosecyu 20.11.2025
Уже можно не только тестировать, но и пользоваться C#. NStar - писать оконные приложения, содержащие надписи, кнопки, текстовые поля и даже изображения, например, моя игра "Три в ряд" написана на этом. . .
Мысли в слух
kumehtar 18.11.2025
Кстати, совсем недавно имел разговор на тему медитаций с людьми. И обнаружил, что они вообще не понимают что такое медитация и зачем она нужна. Самые базовые вещи. Для них это - когда просто люди. . .
Создание Single Page Application на фреймах
krapotkin 16.11.2025
Статья исключительно для начинающих. Подходы оригинальностью не блещут. В век Веб все очень привыкли к дизайну Single-Page-Application . Быстренько разберем подход "на фреймах". Мы делаем одну. . .
Фото: Daniel Greenwood
kumehtar 13.11.2025
Расскажи мне о Мире, бродяга
kumehtar 12.11.2025
— Расскажи мне о Мире, бродяга, Ты же видел моря и метели. Как сменялись короны и стяги, Как эпохи стрелою летели. - Этот мир — это крылья и горы, Снег и пламя, любовь и тревоги, И бескрайние. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2025, CyberForum.ru