-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
allcommands.ps1
2111 lines (1799 loc) · 92.7 KB
/
allcommands.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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### DO NOT EDIT THIS FILE DIRECTLY ###
#.ExternalHelp HelpOut-Help.xml
function Get-MAML
{
[CmdletBinding(DefaultParameterSetName='CommandInfo')]
[OutputType([string],[xml])]
[Alias('ConvertTo-MAML')]
param(
# The name of or more commands.
[Parameter(ParameterSetName='ByName',Position=0,ValueFromPipelineByPropertyName=$true)]
[string[]]
$Name,
# The name of one or more modules.
[Parameter(ParameterSetName='ByModule',ValueFromPipelineByPropertyName=$true)]
[string[]]
$Module,
# The CommandInfo object (returned from Get-Command).
[Parameter(Mandatory=$true,ParameterSetName='FromCommandInfo', ValueFromPipeline=$true)]
[Management.Automation.CommandInfo[]]
$CommandInfo,
# If set, the generated MAML will be compact (no extra whitespace or indentation). If not set, the MAML will be indented.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$Compact,
# If set, will return the MAML as an XmlDocument. The default is to return the MAML as a string.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$XML,
# If set, the generate MAML will not contain a version number.
# This slightly reduces the size of the MAML file, and reduces the rate of changes in the MAML file.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('Unversioned')]
[switch]
$NoVersion,
# A list of command types to skip.
# If not provided, all types of commands from the module will be saved as a markdown document.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('SkipCommandTypes','ExcludeCommandType','ExcludeCommandTypes')]
[Management.Automation.CommandTypes[]]
$SkipCommandType,
# If set, will include aliases in the MAML output.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('IncludeAliases')]
[switch]
$IncludeAlias
)
begin {
# First, we need to create a list of all commands we encounter (so we can process them at the end)
$allCommands = [Collections.ArrayList]::new()
# Then, we want to get the type accelerators (so we don't have to keep getting them each time we're interested)
$typeAccelerators = [PSOBject].Assembly.GetType('System.Management.Automation.TypeAccelerators')::Get
# Next up, we're going to declare a bunch of ScriptBlocks, which we'll call to construct the XML in pieces.
# This way we can create a nested structure (in this case, XML), by calling the pieces we want and letting them return the XML in chunks
#region Get TypeName
$GetTypeName = {param([Type]$t)
# We'll want to check to see if there are any accelerators.
if (-not $typeAccelerators -and $typeAccelerators.GetEnumerator) { # If there weren't
return $t.Fullname # return the fullname.
}
foreach ($_ in $typeAccelerators.GetEnumerator()) { # Loop through the accelerators.
if ($_.Value -eq $t) { # If it's an accelrator for the target type
return $_.Key.Substring(0,1).ToUpper() + $_.Key.Substring(1) # return the key (and fix it's casing)
}
}
return $t.Fullname # If we didn't find it in the accelerators list, return the fullname.
}
#endregion Get TypeName
#region Write Type
# Both Inputs and Outputs have the same internal tag structure for a value, so one script block handles both cases.
$WriteType = {param($t)
$typename = $t.type[0].name
$descriptionLines = $null
if ($in.description) { # If we have a description,
$descriptionLines = $in.Description[0].text -split "`n|`r`n" -ne '' # we we're good.
} else { # If we didn't, it's probably because comment based help mangles things a bit (it puts everything in a long typename).
# Let's fix this by assigning the inType from the first line, and setting the rest as description lines
$typename, $descriptionLines = $t.type[0].Name -split "`n|`r`n" -ne ''
}
$typename = [Security.SecurityElement]::Escape("$typename".Trim())
"<dev:type><maml:name>$typename</maml:name><maml:uri/><maml:description /></dev:type>" # Write the type information
if ($descriptionLines) { # If we had a description
'<maml:description>'
foreach ($line in $descriptionLines) { # Write each line in it's own para tag so that it renders right.
$esc = [Security.SecurityElement]::Escape($line)
"<maml:para>$esc</maml:para>"
}
'</maml:description>'
}
}
#endregion Write Type
#region Write Command Details
$writeCommandDetails = {
# The command.details tag has 5 parts we want to provide
# * Name,
# * Noun
# * Verb
# * Synopsis
# * Version
$Version = "<dev:version>$(if ($cmdInfo.Version) { $cmdInfo.Version.ToString() })</dev:version>"
"<command:details>
<command:name>$([Security.SecurityElement]::Escape($cmdInfo.Name))</command:name>
<command:noun>$noun</command:noun>
<command:verb>$verb</command:verb>
<maml:description>
<maml:para>$([Security.SecurityElement]::Escape($commandHelp.Synopsis))</maml:para>
</maml:description>
$(if (-not $NoVersion) { $Version})
</command:details>
<maml:description>
$(
foreach ($line in @($commandHelp.Description)[0].text -split "`n|`r`n") {
if (-not $line) { continue }
"<maml:para>$([Security.SecurityElement]::Escape($Line))</maml:para>"
}
)
</maml:description>
"
}
#endregion Write Command Details
#region Write Parameter
$WriteParameter = {
# Prepare the command.parameter attributes:
$position = if ($param.Position -ge 0) { $param.Position } else {"named" } #* Position
$fromPipeline = #*FromPipeline
if ($param.ValueFromPipeline) { "True (ByValue)" }
elseif ($param.ValueFromPipelineByPropertyName) { "True (ByPropertyName)" }
else { "False" }
$isRequired = if ($param.IsMandatory) { "true" } else { "false" } #*Required
# Pick out the help for a given parameter
$paramHelp = foreach ($_ in $commandHelp.parameters.parameter) {
if ( $_.Name -eq $param.Name ){
$_
break
}
}
$paramTypeName = & $GetTypeName $param.ParameterType # and get the type name of the parameter type.
"<command:parameter required='$isRequired' position='$position' pipelineInput='$fromPipeline' aliases='' variableLength='true' globbing='false'>" #* Echo the start tag
"<maml:name>$($param.Name)</maml:name>" #* The maml.name tag
'<maml:description>' #*The description tag
foreach ($d in $paramHelp.Description) {
"<maml:para>$([Security.SecurityElement]::Escape($d.Text))</maml:para>"
}
'</maml:description>'
#*The parameterValue tag (which oddly enough, describes the parameter type)
"<command:parameterValue required='$isRequired' variableLength='true'>$paramTypeName</command:parameterValue>"
#*The type tag (which is also it's type)
"<dev:type><maml:name>$paramTypeName</maml:name><maml:uri /></dev:type>"
#*and an empty default value.
'<dev:defaultValue></dev:defaultValue>'
#* Then close the parameter tag.
'</command:parameter>'
}
#endregion Write Parameter
#region Write Parameters
$WriteCommandParameters = {
'<command:parameters>' # *Open the parameters tag;
foreach ($param in ($cmdMd.Parameters.Values | Sort-Object Name)) { #*Loop through the command's parameters alphabetically
& $WriteParameter #*Write each parameter.
}
'</command:parameters>' #*Close the parameters tag
}
#endregion Write Parameters
#region Write Examples
$WriteExamples = {
# If there were no examples, return.
if (-not $commandHelp.Examples.example) { return }
"<command:examples>"
foreach ($ex in $commandHelp.Examples.Example) { # For each example:
'<command:example>' #*Start an example tag
'<maml:title>'
$ex.Title #*Put it's title in a maml:title tag
'</maml:title>'
'<maml:introduction>'#* Put it's introduction in a maml:introduction tag
foreach ($i in $ex.Introduction) {
'<maml:para>'
[Security.SecurityElement]::Escape($i.Text)
'</maml:para>'
}
'</maml:introduction>'
'<dev:code>' #* Put it's code in a dev:code tag
[Security.SecurityElement]::Escape($ex.Code)
'</dev:code>'
'<dev:remarks>' #* Put it's remarks in a dev:remarks tag
foreach ($i in $ex.Remarks) {
if (-not $i -or -not $i.Text.Trim()) { continue }
'<maml:para>'
[Security.SecurityElement]::Escape($i.Text)
'</maml:para>'
}
'</dev:remarks>'
'</command:example>'
}
'</command:examples>'
}
#endregion Write Examples
#region Write Inputs
$WriteInputs = {
if (-not $commandHelp.inputTypes) { return } # If there were no input types, return.
'<command:inputTypes>' #*Open the inputTypes Tag.
foreach ($in in $commandHelp.inputTypes[0].inputType) { #*Walk thru each type in help.
'<command:inputType>'
& $WriteType $in #*Write the type information (in an inputType tag).
'</command:inputType>'
}
'</command:inputTypes>' #*Close the Input Types Tag.
}
#endregion Write Inputs
#region Write Outputs
$WriteOutputs = {
if (-not $commandHelp.returnValues) { return } # If there were no return values, return.
'<command:returnValues>' # *Open the returnValues tag
foreach ($rt in $commandHelp.returnValues[0].returnValue) { # *Walk thru each return value
'<command:returnValue>'
& $WriteType $rt # *write the type information (in an returnValue tag)
'</command:returnValue>'
}
'</command:returnValues>' #*Close the returnValues tag
}
#endregion Write Outputs
#region Write Notes
$WriteNotes = {
if (-not $commandHelp.alertSet) { return } # If there were no notes, return.
"<maml:alertSet><maml:title></maml:title>" #*Open the alertSet tag and emit an empty title
foreach ($note in $commandHelp.alertSet[0].alert) { #*Walk thru each note
"<maml:alert><maml:para>"
$([Security.SecurityElement]::Escape($note.Text)) #*Put each note in a maml:alert element
"</maml:para></maml:alert>"
}
"</maml:alertSet>" #*Close the alertSet tag
}
#endregion Write Notes
#region Write Syntax
$WriteSyntax = {
if (-not $cmdInfo.ParameterSets) { return } # If this command didn't have parameters, return
"<command:syntax>" #*Open the syntax tag
foreach ($syn in $cmdInfo.ParameterSets) {#*Walk thru each parameter set
"<command:syntaxItem><maml:name>$($cmdInfo.Name)</maml:name>" #*Create a syntaxItem tag, with the name of the command.
foreach ($param in $syn.Parameters) {
#* Skip parameters that are not directly declared (e.g. -ErrorAction)
if (-not $cmdMd.Parameters.ContainsKey($param.Name)) { continue }
& $WriteParameter #* Write help for each parameter
}
"</command:syntaxItem>" #*Close the syntax item tag
}
"</command:syntax>"#*Close the syntax tag
}
#endregion Write Syntax
#region Write Links
$WriteLinks = {
# If the command didn't have any links, return.
if (-not $commandHelp.relatedLinks.navigationLink) { return }
'<maml:relatedLinks>' #* Open a related Links tag
foreach ($l in $commandHelp.relatedLinks.navigationLink) { #*Walk thru each link
$linkText, $LinkUrl = "$($l.linkText)".Trim(), "$($l.Uri)".Trim() # and write it's tag.
'<maml:navigationLink>'
"<maml:linkText>$linkText</maml:linkText>"
"<maml:uri>$LinkUrl</maml:uri>"
'</maml:navigationLink>'
}
'</maml:relatedLinks>' #* Close the related Links tag
}
#endregion Write Links
#- - - Now that we've declared all of these little ScriptBlock parts, we'll put them in a list in the order they'll run.
$WriteMaml = $writeCommandDetails, $writeSyntax,$WriteCommandParameters,$WriteInputs,$writeOutputs, $writeNotes, $WriteExamples, $writeLinks
#- - -
}
process {
if ($PSCmdlet.ParameterSetName -eq 'ByName') { # If we're getting comamnds by name,
$CommandInfo = @(foreach ($n in $name) {
$ExecutionContext.InvokeCommand.GetCommands($N,'Function,Cmdlet', $true) # find each command (treating Name like a wildcard).
})
}
if ($PSCmdlet.ParameterSetName -eq 'ByModule') { # If we're getting commands by module
$CommandInfo = @(foreach ($m in $module) { # find each module
(Get-Module -Name $m).ExportedCommands.Values # and get it's exports.
})
}
$filteredCmds = @(foreach ($ci in $CommandInfo) { # Filter the list of commands
# (throw out applications)
if ($ci -is [Management.Automation.ApplicationInfo]) {
continue
}
if ($ci -is [Management.Automation.AliasInfo]) {
if (-not $IncludeAlias) { continue }
}
if ($SkipCommandType -and
$SkipCommandType -contains $ci.CommandType) { continue } # (throw out any we were told to skip)
$ci
})
if ($filteredCmds) {
$null = $allCommands.AddRange($filteredCmds)
}
}
end {
$c, $t, $id, $maml = # Create some variables for our progress bar,
0, $allCommands.Count, [Random]::new().Next(), [Text.StringBuilder]::new('<helpItems schema="maml">') # and initialize our MAML.
foreach ($cmdInfo in $allCommands) { # Walk thru each command.
$commandHelp = $null
$c++
$p = $c * 100 / $t
Write-Progress 'Converting to MAML' "$cmdInfo [$c of $t]" -PercentComplete $p -Id $id # Write a progress message
$commandHelp = $cmdInfo | Get-Help # get it's help
$cmdMd = [Management.Automation.CommandMetaData]$cmdInfo # get it's command metadata
if (-not $commandHelp -or $commandHelp -is [string]) { # (error if we couldn't Get-Help)
Write-Error "$cmdInfo Must have a help topic to convert to MAML"
return
}
$verb, $noun = $cmdInfo.Name -split "-" # and split out the noun and verb.
# Now we're ready to run all of those script blocks we declared in begin.
# All we need to do is append the command node, run each of the script blocks in $WriteMaml, and close the node.
$mamlCommand =
"<command:command
xmlns:maml='http://schemas.microsoft.com/maml/2004/10'
xmlns:command='http://schemas.microsoft.com/maml/dev/command/2004/10'
xmlns:dev='http://schemas.microsoft.com/maml/dev/2004/10'>
$(foreach ($_ in $WriteMaml) { & $_ })
</command:command>"
$null = $maml.AppendLine($mamlCommand)
}
Write-Progress "Exporting Maml" " " -Completed -Id $id # Then we indicate we're done,
$null = $maml.Append("</helpItems>") # close the opening tag.
$mamlAsXml = [xml]"$maml" # and convert the whole thing to XML.
if (-not $mamlAsXml) { return } # If we couldn't, return.
if ($XML) { return $mamlAsXml } # If we wanted the XML, return it.
$strWrite = [IO.StringWriter]::new() # Now for a little XML magic:
# If we create a [IO.StringWriter], we can save it as pretty or compacted XML.
$mamlAsXml.PreserveWhitespace = $Compact # Oddly enough, if we're compacting we're setting preserveWhiteSpace to true, which in turn strips all of the whitespace except that inside of your nodes.
$mamlAsXml.Save($strWrite) # Anyways, we can save this to the string writer, and it will either make our XML perfectly balanced and indented or compact and free of most whitespace.
# Unfortunately, it will not get it's encoding declaration "right". This is because $strWrite is Unicode, and in most cases we'll want our XML to be UTF8.
# The next step of the pipeline needs to convert it as it is saved, which is as easy as | Out-File -Encoding UTF8.
"$strWrite".Replace('<?xml version="1.0" encoding="utf-16"?>','<?xml version="1.0" encoding="utf-8"?>')
$strWrite.Close()
$strWrite.Dispose()
}
}
#.ExternalHelp HelpOut-Help.xml
function Get-MarkdownHelp {
[Reflection.AssemblyMetadata("HelpOut.TellStory", $true)]
[Reflection.AssemblyMetadata("HelpOut.Story.Process", "For each Command")]
[OutputType('PowerShell.Markdown.Help')]
param(
# The name of the specified command or concept.
[Parameter(Position=0, ValueFromPipelineByPropertyName)]
[ValidateNotNullOrEmpty()]
[string]
$Name,
# If set, will generate a markdown wiki. Links will be relative to the current path, and will not include the .md extensions
[switch]
$Wiki,
# If set, will interlink documentation as if it were for GitHub pages, beneath a given directory
[Alias('GitHubPageRoot')]
[string]
$GitHubDocRoot,
# If provided, will rename the help topic before getting markdown.
[Parameter(ValueFromPipelineByPropertyName)]
[string]
$Rename,
# The order of the sections.
# If not provided, this will be the order they are defined in the formatter.
[Parameter(ValueFromPipelineByPropertyName)]
[string[]]
$SectionOrder,
# If set, will not enumerate valid values and enums of parameters.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$NoValidValueEnumeration,
# If set, will not attach a YAML header to the generated help.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('IncludeFrontMatter', 'IncludeHeader')]
[switch]
$IncludeYamlHeader,
# The type of information to include in the YAML Header
[ValidateSet('Command','Help','Metadata')]
[Alias('YamlHeaderInfoType')]
[string[]]
$YamlHeaderInformationType,
# The formatting used for unknown attributes.
# Any key or property in this object will be treated as a potential typename
# Any value will be the desired formatting.
# If the value is a [ScriptBlock], the [ScriptBlock] will be run.
# If the value is a [string], it will be expanded
# In either context, `$_` will be the current attribute.
[PSObject]
$FormatAttribute
)
process
{
# We start off by copying the bound parameters
$myParams= @{} + $PSBoundParameters
# and then we call Get-Help.
$getHelp = @{name=$Name}
$gotHelp = Get-Help @getHelp
# If we could not Get-Help,
if (-not $gotHelp) {
Write-Error "Could not get help for $name"
return # we error out.
}
# We need to decorate the output of Get-Help so it renders as markdown,
# so we pipe thru all results from Get-Help.
$gotHelp |
& { process {
# Get-Help can return either a help topic or command help.
$in = $_
# Help topics will be returned as a string
if ($in -is [string]) {
$in # (which we will output as-is for now).
} else {
$helpObj = $_
# Command Help will be returned as an object
# We decorate that object with the typename `PowerShell.Markdown.Help`.
# $helpObj.pstypenames.clear()
$helpObj.pstypenames.insert(0,'PowerShell.Markdown.Help')
$IsHelpAboutAlias = $helpObj.Name -ne $gotHelp.Name
$helpObj | Add-Member NoteProperty IsAlias $IsHelpAboutAlias -Force
if ($IsHelpAboutAlias) {
$aliasCommand = $ExecutionContext.SessionState.InvokeCommand.GetCommand($gotHelp.Name, 'Alias')
$helpObj | Add-Member NoteProperty AliasCommand $aliasCommand -Force
}
# Then we attach parameters passed to this command to the help object.
# * `-Rename` will become `[string] .Rename`
if ($Rename) {
$helpObj | Add-Member NoteProperty Rename $Rename -Force
} elseif ($IsHelpAboutAlias) {
$helpObj | Add-Member NoteProperty Rename $getHelp.Name -Force
}
# * `-SectionOrder` will become `[string[]] .SectionOrder`
if ($SectionOrder) {
$helpObj | Add-Member NoteProperty SectionOrder $SectionOrder -Force
}
# * `-Wiki` will become `[bool] .WikiLink`
$helpObj | Add-Member NoteProperty WikiLink ($Wiki -as [bool]) -Force
# * `-GitHubDocRoot` will become `.DocLink`
if ($myParams.ContainsKey("GitHubDocRoot")) {
$helpObj | Add-Member NoteProperty DocLink $GitHubDocRoot -Force
}
# * `-NoValidValueEnumeration`
$helpObj | Add-Member NoteProperty NoValidValueEnumeration $NoValidValueEnumeration -Force
# * `-IncludeYamlHeader`
$helpObj | Add-Member NoteProperty IncludeYamlHeader $IncludeYamlHeader -Force
# * `-NoValidValueEnumeration`
$helpObj | Add-Member NoteProperty YamlHeaderInformationType $YamlHeaderInformationType -Force
if ($FormatAttribute) {
$helpObj | Add-Member NoteProperty FormatAttribute $FormatAttribute -Force
}
# After we've attached all of the properties, we simply output the object.
# PowerShell.Markdown.Help formatter will display it exactly as we'd like it.
$helpObj
}
}
}
}
}
#requires -version 3.0
function Get-ScriptReference
{
[CmdletBinding(DefaultParameterSetName='FilePath')]
param(
# The path to a file
[Parameter(Mandatory=$true,Position=0,ParameterSetName='FilePath',ValueFromPipelineByPropertyName=$true)]
[Alias('Fullname')]
[string[]]
$FilePath,
# One or more PowerShell ScriptBlocks
[Parameter(Mandatory=$true,Position=0,ParameterSetName='ScriptBlock',ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
[Alias('Definition')]
[ScriptBlock[]]
$ScriptBlock,
# If set, will recursively find references.
[switch]
$Recurse
)
begin {
# Let's declare some collections we'll need:
$allFiles = [Collections.ArrayList]::new() # * A list of all files (if any are piped in)
$LookedUpCommands = @{} # * The commands we've already looked up (to save time)
}
process {
#region Process Piped in Files
if ($PSCmdlet.ParameterSetName -eq 'FilePath') { # If we're piping in files,
$allFiles.AddRange($FilePath) # add them to the list and process them in the end,
return # and stop processing for good measure.
}
#endregion Process Piped in Files
#region Get the Script References
# To start off with, take all of the scripts passed in and put them in a queue.
$scriptBlockQueue = [Collections.Generic.Queue[ScriptBlock]]::new($ScriptBlock)
$resolvedCmds = @{} # Then create a hashtable to store the resolved references
$alreadyChecked = [Collections.Generic.List[ScriptBlock]]::new() # and a list of all of the ScriptBlock's we've already taken a look at.
# Now it's time for some syntax trickery that should probably be explained.
# We're going to want to be able to recursively find references too.
# By putting this in a queue, we've already done part of the work,
# because we can just enqueue the nested commands.
# However, we also want to know _which nested command had which references_
# This means we have to collect all of the references as we go,
# and output them in a different way if we're running recursively.
# Got all that?
# First, we need a tracking variable
$CurrentCommand = '.' # for the current command.
# Now the syntax trickery: We put the do loop inside of a lambda running in our scope (. {}).
# This gives us all of our variables, but lets the results stream to the pipeline.
# This is actually pretty important, since this way our tracking variable is accurate when we're outputting the results.
# Now that we understand how it works, let's get to:
#region Process the Queue of Script Blocks
. {
$alreadyChecked = [Collections.ArrayList]::new()
do {
$scriptBlock = $scriptBlockQueue.Dequeue()
if ($alreadyChecked -contains $scriptBlock) { continue }
$null= $alreadyChecked.Add($ScriptBlock)
$foundRefs = $Scriptblock.Ast.FindAll({
param($ast)
$ast -is [Management.Automation.Language.CommandAst] -or
$ast -is [Management.Automation.Language.TypeConstraintAst] -or
$ast -is [Management.Automation.Language.TypeExpressionAst]
}, $true)
$cmdRefs = [Collections.ArrayList]::new()
$cmdStatements = [Collections.ArrayList]::new()
$typeRefs = [Collections.ArrayList]::new()
foreach ($ref in $foundRefs) {
if ($ref -is [Management.Automation.Language.CommandAst]) {
$null = $cmdStatements.Add($ref)
if (-not $ref.CommandElements) { continue }
$theCmd = $ref.CommandElements[0]
if ($theCmd.Value) {
if (-not $LookedUpCommands[$theCmd.Value]) {
$LookedUpCommands[$thecmd.Value] = $ExecutionContext.InvokeCommand.GetCommand($theCmd.Value, 'Cmdlet, Function, Alias')
}
if ($cmdRefs -notcontains $LookedUpCommands[$theCmd.Value]) {
$null = $cmdRefs.Add($LookedUpCommands[$thecmd.Value])
}
} else {
# referencing a lambda, leave it alone for now
}
} elseif ($ref.TypeName) {
$refType = $ref.TypeName.Fullname -as [type]
if ($typeRefs -notcontains $refType) {
$null = $typeRefs.Add($refType)
}
}
}
[PSCustomObject][Ordered]@{
Commands = $cmdRefs.ToArray()
Statements = $cmdStatements.ToArray()
Types = $typeRefs.ToArray()
}
if ($Recurse) {
$uniqueCmdRefs |
& { process {
if ($resolvedCmds.ContainsKey($_.Name)) { return }
$nextScriptBlock = $_.ScriptBlock
if (-not $nextScriptBlock -and $_.ResolvedCommand.ScriptBlock) {
$nextScriptBlock = $_.ResolvedCommand.ScriptBlock
}
if ($nextScriptBlock) {
$scriptBlockQueue.Enqueue($nextScriptBlock)
$resolvedCmds[$_.Name] = $true
}
} }
}
} while ($ScriptBlockQueue.Count) } |
#endregion Process the Queue of Script Blocks
#region Handle Each Output
& {
begin {
$refTable = @{}
}
process {
if (-not $Recurse) { return $_ }
}
}
#endregion Handle Each Output
#endregion Get the Script References
}
end {
$myParams = @{} + $PSBoundParameters
if (-not $allFiles.Count) { return }
$c, $t, $id = 0, $allFiles.Count, [Random]::new().Next()
foreach ($file in $allFiles) {
$c++
$resolvedFile= try { $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($file)} catch { $null }
if (-not $resolvedFile) { continue }
$resolvedFile = [IO.FileInfo]"$resolvedFile"
if (-not $resolvedFile.Name) { continue }
if (-not $resolvedFile.Length) { continue }
if ('.ps1', '.psm1' -notcontains $resolvedFile.Extension) { continue }
$p = $c * 100 / $t
$text = [IO.File]::ReadAllText($resolvedFile.FullName)
$scriptBlock= [ScriptBlock]::Create($text)
Write-Progress "Getting References" " $($resolvedFile.Name) " -PercentComplete $p -Id $id
if (-not $scriptBlock) { continue }
Get-ScriptReference -ScriptBlock $scriptBlock |
& { process {
$_.psobject.properties.add([Management.Automation.PSNoteProperty]::new('FileName',$resolvedFile.Name))
$_.psobject.properties.add([Management.Automation.PSNoteProperty]::new('FilePath',$resolvedFile.Fullname))
$_.pstypenames.add('HelpOut.Script.Reference')
$_
} }
Write-Progress "Getting References" " " -Completed -Id $id
}
}
}
#.ExternalHelp HelpOut-Help.xml
function Get-ScriptStory
{
[CmdletBinding(DefaultParameterSetName='ScriptBlock')]
param(
# A script block
[Parameter(Mandatory=$true,Position=0,ValueFromPipeline=$true,ParameterSetName='ScriptBlock')]
[ScriptBlock]
$ScriptBlock,
# A block of text
[Parameter(Mandatory=$true,Position=0,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,ParameterSetName='ScriptText')]
[Alias('ScriptContents', 'Definition')]
[string]
$Text,
# The friendly names of code regions or begin,process, or end blocks.
[Collections.IDictionary]
$RegionName = @{
begin = "Before any input"
process = "On Each Input"
end = "After all input"
},
[int]
$HeadingSize = 3)
process {
function foo($x, $y) {
# Documentation should be ignored
}
# First, we want to convert any text input to -ScriptBlock.
if ($PSCmdlet.ParameterSetName -eq 'ScriptText') {
$ScriptBlock = [ScriptBlock]::Create($Text)
}
# Next, we tokenize the script and force it into an array.
$tokens = @([Management.Automation.PSParser]::Tokenize("$ScriptBlock", [ref]$null))
# We need to keep track of how many levels of regions we're in, so create a $RegionStack.
$regionStack = [Collections.Stack]::new()
# We'll also want to make a StringBuilder (because it will be faster).
$sb= [text.stringbuilder]::new()
# Last but not least, we'll want to keep track of a block depth, so initialize that to zero.
$blockDepth = 0
#region Walk Thru Tokens
for ($i =0; $i -lt $tokens.Length; $i++) {
# As we pass GroupStarts and GroupEnds, nudge the block depth.
if ($tokens[$i].Type -eq 'GroupStart') { $blockDepth++ }
if ($tokens[$i].Type -eq 'GroupEnd') { $blockDepth-- }
#region Handle natural regions
# In addition to any regions specified in documentation,
# we can treat the begin, process, and end blocks as effective regions.
if ($tokens[$i].Type -eq 'keyword' -and
'begin', 'process', 'end' -contains $tokens[$i].content -and
$blockDepth -le 1 ) {
# When we encounter one of these regions, pop the region stack
if ($regionStack.Count) { $null = $regionStack.Pop() }
# and push the current region.
$null =$regionStack.Push($tokens[$i].Content)
# Generate the header, which consists of:
$keywordHeader =
# a newline,
[Environment]::NewLine +
# N Markdown headers,
('#' * ([Math]::Min(6, $regionStack.Count + $HeadingSize - 1))) + ' ' +
# the friendly name for the region (or just it's content),
$(if ($RegionName[$tokens[$i].Content]) {
$RegionName[$tokens[$i].Content]
} else {
$tokens[$i].Content
}) +
# and another newline.
[Environment]::NewLine
# Then, append the header.
$null = $sb.Append($keywordHeader)
continue
}
#endregion Handle natural regions
#region Skip Parameter Block
# We don't want all of the documentation.
# Specifically, we want to avoid any parameter documentation and nested functions.
# To do this, we need to notice the param and function keyword when it shows up.
if ($tokens[$i].Type -eq 'keyword' -and 'param', 'function' -contains $tokens[$i].Content) {
# Once we've found it, we advance until we find the next GroupStart.
$j = $i + 1
while ($tokens[$j].Type -ne 'GroupStart') { $j++ }
$skipGroupCount = 1
if ($tokens[$j].Content -eq '(' -and # If the GroupStart was an open paranthesis
$tokens[$i].Content -eq 'function'# and we're dealing with a nested function,
) {
$skipGroupCount = 2 # we're going to need to this next bit twice.
}
foreach ($n in 1..$skipGroupCount) {
# Look for the GroupStart.
while ($tokens[$j].Type -ne 'GroupStart') { $j++ }
# Then we set a variable to track depth
$depth = 0
do {
# and walk thru the tokens
if ($tokens[$j].Type -eq 'GroupStart') { $depth++ }
if ($tokens[$j].Type -eq 'GroupEnd') { $depth-- }
$j++
} while ($depth -and $tokens[$j]) # until the depth is 0 again.
}
$i = $j # Finally we set the iterator to current position (thus skipping the param block).
}
#endregion Skip Parameter Block
#region Check for Paragraph Breaks
# Next we need to check for paragraph breaks.
if ($i -ge 2 -and
$tokens[$i].Type -eq 'Newline' -and # If the current token is a newline,
$tokens[$i -1].Type -eq 'Newline') # and the token before that was also a newline,
{
# then it's probably a paragraph break
if ($i -ge 3 -and $tokens[$i - 2].Type -eq 'GroupEnd')
{
# (Unless it followed a GroupEnd).
continue
}
# When we encounter a paragraph break, output two newlines.
$null = $sb.Append([Environment]::NewLine * 2)
}
#endregion Check for Paragraph Breaks
#region Process Comments
# At this point, we don't care about anything other than comments.
# So if it's not a comment, continue past them.
if ($tokens[$i].Type -ne 'Comment') { continue }
$Comment = $tokens[$i].Content.Trim([Environment]::NewLine).Trim()
if ($Comment.StartsWith('<')) { # If it's a block comment,
# make sure it's not a special-purpose block comment (like inline help).
$trimmedComment = $comment.Trim('<#').Trim([Environment]::NewLine).Trim()
if ('?', '.', '{','-','|' -contains $trimmedComment[0]) { # If it was,
continue # continue on.
}
# If it wasn't, trim the block comment and newlines.
$Comment = $Comment.Trim().Trim("><#").Trim([Environment]::NewLine)
}
# We'll need to know if it's a region
# so we'll use some fancy Regex to extract it's name
# (and if it's an EndRegion or not).
if ($Comment.Trim() -match '#(?<IsEnd>end){0,1}region(?<RegionName>.{1,})') {
$thisRegionName = $Matches.RegionName.Trim()
if ($Matches.IsEnd) {
# If it was an EndRegion, pop it off of the Region Stack.
$null = $regionStack.Pop()
} else {
# If it wasn't, push it onto the Region Stack.
$null = $regionStack.Push($thisRegionName)
# Then, output it's name a markdown header,
# using the count of RegionStack to determine H1, H2, etc.
$regionContent =
[Environment]::NewLine +
('#' * ([Math]::Min(6, $regionStack.Count + $HeadingSize - 1))) + ' '+
$(if ($RegionName[$thisRegionName]) {
$RegionName[$thisRegionName]
} else {
$Matches.RegionName.Trim()
}) +
[Environment]::NewLine
$null = $sb.Append($regionContent)
}
# We still don't want the region name to become part of the story,
# so continue to the next token.
continue
}
# Whatever comment is left is new story content.
$newStory = $Comment.TrimStart('#').Trim()
# If there's any content already,
if ($sb.Length) {
# before we put it into the string,
$null =
if ($sb[-1] -eq '.') {
# add a double space (after a period),
$sb.Append(' ')
} else {
# or a single space.
$sb.Append(' ')
}
}
$shouldHaveNewline =
$newStory.StartsWith('*') -or
$newStory.StartsWith('-') -or
($lastStory -and ($lastStory.StartsWith('*') -or $lastStory.StartsWith('-')))
if ($shouldHaveNewline) {
$null = $sb.Append([Environment]::NewLine)
}
# Finally, append the new story content.
$null = $sb.Append($newStory)
#endregion Process Comments
}
#endregion Walk Thru Tokens
# After everything is done, output the content of the string builder.
"$sb"
}
}
#.ExternalHelp HelpOut-Help.xml
function Install-MAML
{
[OutputType([Nullable], [IO.FileInfo])]
param(
# The name of one or more modules.
[Parameter(Mandatory,Position=0,ParameterSetName='Module',ValueFromPipelineByPropertyName)]
[string[]]
$Module,
# If set, will refresh the documentation for the module before generating the commands file.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$NoRefresh,
# If set, will compact the generated MAML. This will be ignored if -Refresh is not passed, since no new MAML will be generated.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$Compact,
# The name of the combined script. By default, allcommands.ps1.
[Parameter(Position=1,ValueFromPipelineByPropertyName)]
[string]
$ScriptName = 'allcommands.ps1',
# The root directories containing functions. If not provided, the function root will be the module root.
[Parameter(ValueFromPipelineByPropertyName)]
[string[]]
$FunctionRoot,
# If set, the function roots will not be recursively searched.
[Parameter(ValueFromPipelineByPropertyName)]
[switch]
$NoRecurse,
# The encoding of the combined script. By default, UTF8.
[Parameter(Position=2,ValueFromPipelineByPropertyName)]
[ValidateNotNull()]
[Text.Encoding]