-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy pathsyntax_test_Function.ps1
399 lines (390 loc) · 20.9 KB
/
syntax_test_Function.ps1
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# SYNTAX TEST "Packages/PowerShell/PowerShell.sublime-syntax"
using module Microsoft.Management
# <- keyword.control.using
# ^ keyword.other
# ^ variable.parameter
<#
# <- punctuation.definition.comment.block.begin
.Synopsis
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Short description
.DESCRIPTION
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Long description
.EXAMPLE
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Example of how to use this cmdlet
.EXAMPLE
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Another example of how to use this cmdlet
.INPUTS
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Inputs to this cmdlet (if any)
.OUTPUTS
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
Output from this cmdlet (if any)
.NOTES
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
General notes
.COMPONENT
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
The component this cmdlet belongs to
.ROLE
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
The role this cmdlet belongs to
.FUNCTIONALITY
# <- punctuation.definition.keyword
# ^ keyword.other.documentation
The functionality that best describes this cmdlet
This should not be considered documentaton -> .role
# ^ - keyword.operator.documentation
#>
# <- punctuation.definition.comment.block.end
function Verb-Noun {
#^^^^^^^^^^^^^^^^^ meta.function
#^^^^^^^ storage.type
# ^^^^^^^^^ entity.name.function
# @@@@@@@@@ definition
[CmdletBinding(DefaultParameterSetName = 'Parameter Set 1',
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^ meta.attribute string.quoted.single
SupportsShouldProcess = $true,
# ^^^^^^^^^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^ meta.attribute punctuation.definition.variable
# ^^^^ meta.attribute constant.language
PositionalBinding = $false,
# ^^^^^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^ meta.attribute punctuation.definition.variable
# ^^^^^ meta.attribute constant.language
HelpUri = 'http://www.microsoft.com/',
# ^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^ meta.attribute string.quoted.single
ConfirmImpact = 'Medium')]
# ^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^ meta.attribute string.quoted.single
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[Alias()]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[OutputType([String])]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute punctuation.section.brackets.begin
# ^^^^^^ meta.attribute storage.type
# ^ meta.attribute punctuation.section.brackets.end
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
Param
#^^^^^ keyword.declaration.parameter
(
# <- punctuation.section.group.begin
# Param1 help description
# <- comment.line punctuation.definition.comment
# ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
[Parameter(Mandatory=$true,
#^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^ support.function.attribute
# ^ punctuation.section.group.begin
# ^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^ punctuation.definition.variable
# ^^^^ constant.language
# ^ punctuation.separator
ValueFromPipeline=$true,
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute.powershell
# ^^^^^^^^^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^ punctuation.definition.variable
# ^^^^ constant.language
# ^ punctuation.separator
ValueFromPipelineByPropertyName = $true,
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^ punctuation.definition.variable
# ^^^^^ constant.language
# ^ punctuation.separator
ValueFromRemainingArguments=$false,
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^ punctuation.definition.variable
# ^^^^^ constant.language
# ^ punctuation.separator
Position=0,
#^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# ^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^ constant.numeric.value
# ^ punctuation.separator
ParameterSetName = 'Parameter Set 1')]
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# ^^^^^^^^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^^^^^^^^^^^^^^^^^ string.quoted.single
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
# ^ - meta.attribute
[ValidateNotNullOrEmpty()]
#^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^^^^^^^^^^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[ValidateNotNull()]
#^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^^^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[ValidateNotNullOrEmpty()]
#^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^^^^^^^^^^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[ValidateCount(0,5)]
#^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ constant.numeric.value
# ^ punctuation.separator
# ^ constant.numeric.value
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[ValidateSet("sun", "moon", "earth")]
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^ support.function.attribute
# ^ punctuation.section.group.begin
# ^^^^ string.quoted.double
# ^ punctuation.separator
# ^^^^^^ string.quoted.double
# ^ punctuation.separator
# ^^^^^^^ string.quoted.double
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[Alias("p1")]
#^^^^^^^^^^^^ meta.attribute
# <- punctuation.section.brackets.begin
# ^ support.function.attribute
# ^ punctuation.section.group.begin
# ^^^^ string.quoted.double
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
$Param1,
# <- punctuation.definition.variable
# ^ variable.other.readwrite
# ^ punctuation.separator
# Param2 help description
# <- comment.line punctuation.definition.comment
# ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
[Parameter(ParameterSetName='Parameter Set 1')]
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# ^^^^^^^^ support.function.attribute
# ^^^^^^^^^^^^^^^^ variable.parameter.attribute
# ^ keyword.operator.assignment
# ^^^^^^^^^^^^^^^^ string.quoted.single
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
# ^ - meta.attribute
[AllowNull()]
#^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[AllowEmptyCollection()]
#^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[AllowEmptyString()]
#^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[ValidateScript({$true})]
#^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ meta.attribute
# ^ punctuation.definition.variable
# ^^^^ constant.language
# ^ meta.attribute
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[ValidateRange(0,5)]
#^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^^^^^^^^^^^^ support.function.attribute
# ^ punctuation.section.group.begin
# ^ constant.numeric.value
# ^ punctuation.separator
# ^ constant.numeric.value
# ^ punctuation.section.group.end
# ^ punctuation.section.brackets.end
[int32]
# <- punctuation.section.brackets.begin
#^^^^^ storage.type
# ^ punctuation.section.brackets.end
$Param2,
# <- punctuation.definition.variable
# ^ variable.other.readwrite
# ^ punctuation.separator
# Param3 help description
# <- comment.line punctuation.definition.comment
# ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
[Parameter(ParameterSetName='Another Parameter Set')]
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^^^^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute string.quoted.single
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[ValidatePattern("[a-z]*")]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^^^^^^^^ meta.attribute string.quoted.double
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[ValidateLength(0,15)]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute meta.number.integer.decimal constant.numeric.value
# ^ punctuation.separator
# ^^ meta.attribute meta.number.integer.decimal constant.numeric.value
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[String]
# <- punctuation.section.brackets.begin
#^^^^^^ storage.type
# ^ punctuation.section.brackets.end
$Param3,
# <- punctuation.definition.variable
#^^^^^^ variable.other.readwrite
# ^ punctuation.separator
# Param4 help description
# <- comment.line punctuation.definition.comment
# ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
[Parameter(ParameterSetName='Parameter Set 1')]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^^^^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^^^^^^^^^^^^^^^^^ meta.attribute string.quoted.single
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[ValidateScript({Test-Path $_})] #Make sure cmdlets don't break highlighting
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^ meta.attribute meta.block
# ^^^^^^^^^ meta.block support.function
# ^ meta.block punctuation.definition.variable
# ^ meta.block variable.language
# ^ meta.attribute meta.block
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[string]
# <- punctuation.section.brackets.begin
# ^ storage.type
# ^ punctuation.section.brackets.end
$Param4,
# <- punctuation.definition.variable
# ^ variable.other.readwrite
# ^ punctuation.separator
# Param5 help description
# <- comment.line punctuation.definition.comment
# ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
[Parameter(ParameterSetName='Parameter Set 1')]
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^^^^^^^^^^^^^^^^ meta.attribute variable.parameter.attribute
# ^ meta.attribute keyword.operator.assignment
# ^^^^^^^^^^^^^^^^^ meta.attribute string.quoted.single
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
[ValidatePattern('(?=^.{1,254}$)(^(?:(?!\d+\.)[a-zA-Z0-9_\-]{1,63}\.?)+(?:[a-zA-Z]{2,})$)')] # this regex shouldn't break highlighting
# <- meta.attribute punctuation.section.brackets.begin
# ^ meta.attribute support.function.attribute
# ^ meta.attribute punctuation.section.group.begin
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute string.quoted.single
# ^ meta.attribute punctuation.section.group.end
# ^ meta.attribute punctuation.section.brackets.end
# ^ comment.line punctuation.definition.comment
# ^ comment.line
[string]
# <- punctuation.section.brackets.begin
# ^ storage.type
# ^ punctuation.section.brackets.end
$Param5
# <- punctuation.definition.variable
# ^ variable.other.readwrite
)
# <- punctuation.section.group.end
Begin
#^^^^^ keyword.context.block.begin
{
}
Process {
# <- keyword.context.block.process
if ($pscmdlet.ShouldProcess("Target", "Operation")) {
# <- keyword.control
# ^ punctuation.section.group.begin
# ^ punctuation.definition.variable
# ^^^^^^^^ variable.language
# ^^^^^^^^^^^^^ variable.function
# @@@@@@@@@@@@@ reference
# ^ punctuation.section.arguments.begin
# ^^^^^^^^ string.quoted.double
# ^ punctuation.separator
# ^^^^^^^^^^^ string.quoted.double
# ^ punctuation.section.arguments.end
# ^ punctuation.section.group.end
}
}
End {
#^^^ keyword.context.block.end
}
}