PSDocs.psm1
|
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 |
# Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # # PSDocs module # Set-StrictMode -Version latest; [PSDocs.Configuration.PSDocumentOption]::UseExecutionContext($ExecutionContext); [PSDocs.Configuration.PSDocumentOption]::UseCurrentCulture(); $Script:UTF8_NO_BOM = New-Object -TypeName System.Text.UTF8Encoding -ArgumentList $False; # # Localization # Import-LocalizedData -BindingVariable LocalizedHelp -FileName 'PSDocs.Resources.psd1' -ErrorAction SilentlyContinue; if ($Null -eq (Get-Variable -Name LocalizedHelp -ErrorAction SilentlyContinue)) { Import-LocalizedData -BindingVariable LocalizedHelp -FileName 'PSDocs.Resources.psd1' -UICulture 'en-US' -ErrorAction SilentlyContinue; } # # Public functions # #region Cmdlets # .ExternalHelp PSDocs-Help.xml function Invoke-PSDocument { [CmdletBinding(DefaultParameterSetName = 'Input')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'InputPath')] [Alias('f')] [String[]]$InputPath, [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, # The name of the document [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, [Parameter(Mandatory = $False)] [String[]]$Tag, [Parameter(Mandatory = $False)] [String[]]$InstanceName, [Parameter(Mandatory = $False, ValueFromPipeline = $True, ParameterSetName = 'Input')] [PSObject]$InputObject, # The path to look for document definitions in [Parameter(Position = 0, Mandatory = $False)] [PSDefaultValue(Help = '.')] [Alias('p')] [String[]]$Path = $PWD, [Parameter(Mandatory = $False)] [Alias('InputFormat')] [ValidateSet('None', 'Yaml', 'Json', 'PowerShellData', 'Detect')] [PSDocs.Configuration.InputFormat]$Format = [PSDocs.Configuration.InputFormat]::Detect, # The output path to save generated documentation [Parameter(Mandatory = $False)] [String]$OutputPath = $PWD, [Parameter(Mandatory = $False)] [Switch]$PassThru, [Parameter(Mandatory = $False)] [PSDocs.Configuration.PSDocumentOption]$Option, [Parameter(Mandatory = $False)] [PSDocs.Configuration.MarkdownEncoding]$Encoding = [PSDocs.Configuration.MarkdownEncoding]::Default, [Parameter(Mandatory = $False)] [String[]]$Culture, [Parameter(Mandatory = $False)] [String[]]$Convention ) begin { Write-Verbose -Message "[Invoke-PSDocument]::BEGIN"; $pipelineReady = $False; # Check if the path is a directory if (!(Test-Path -Path $Path)) { Write-Error -Message $LocalizedHelp.PathNotFound -ErrorAction Stop; return; } # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSDocumentOption @optionParams; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } if ($sourceParams.Count -eq 0) { $sourceParams['Path'] = $Path; } $sourceParams['Option'] = $Option; [PSDocs.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Warning -Message $LocalizedHelp.SourceNotFound; return; # continue causes issues with Pester } $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSDocs.Configuration.LanguageMode]::ConstrainedLanguage; } # Get parameter options, which will override options from other sources if ($PSBoundParameters.ContainsKey('Name')) { $Option.Document.Include = $Name; } if ($PSBoundParameters.ContainsKey('Tag')) { $Option.Document.Tag = $Tag; } if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } if ($PSBoundParameters.ContainsKey('OutputPath') -and !$PassThru) { $Option.Output.Path = $OutputPath; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } if ($PSBoundParameters.ContainsKey('Encoding')) { $Option.Markdown.Encoding = $Encoding; } $builder = [PSDocs.Pipeline.PipelineBuilder]::Invoke($sourceFiles, $Option, $PSCmdlet, $ExecutionContext); $builder.InstanceName($InstanceName); $builder.Convention($Convention); if ($PSBoundParameters.ContainsKey('InputPath')) { $builder.InputPath($InputPath); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } process { if ($pipelineReady) { try { # Process pipeline objects $pipeline.Process($InputObject); } catch { $pipeline.Dispose(); throw; } } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message "[Invoke-PSDocument]::END"; } } # .ExternalHelp PSDocs-Help.xml function Get-PSDocument { [CmdletBinding()] [OutputType([PSDocs.Definitions.IDocumentDefinition])] param ( [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [Switch]$ListAvailable, # Filter to documents with the following names [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, # A list of paths to check for definitions [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path = $PWD, [Parameter(Mandatory = $False)] [PSDocs.Configuration.PSDocumentOption]$Option ) begin { Write-Verbose -Message "[Get-PSDocument]::BEGIN"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSDocumentOption @optionParams; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } if ($PSBoundParameters.ContainsKey('ListAvailable')) { $sourceParams['ListAvailable'] = $ListAvailable; } if ($sourceParams.Count -eq 0) { $sourceParams['Path'] = $Path; } $sourceParams['Option'] = $Option; [PSDocs.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Verbose -Message $LocalizedHelp.SourceNotFound; return; # continue causes issues with Pester } Write-Verbose -Message "[Get-PSDocument] -- Found $($sourceFiles.Length) source file(s)"; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSDocs.Configuration.LanguageMode]::ConstrainedLanguage; } # Get parameter options, which will override options from other sources if ($PSBoundParameters.ContainsKey('Name')) { $Option.Document.Include = $Name; } $builder = [PSDocs.Pipeline.PipelineBuilder]::Get($sourceFiles, $Option, $PSCmdlet, $ExecutionContext); try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message "[Get-PSDocument]::END"; } } # .ExternalHelp PSDocs-Help.xml function Get-PSDocumentHeader { [CmdletBinding()] param ( [Parameter(Mandatory = $False, ValueFromPipelineByPropertyName = $True)] [Alias('FullName')] [String]$Path = $PWD ) process { $filteredItems = Get-ChildItem -Path (Join-Path -Path $Path -ChildPath '*') -File; foreach ($item in $filteredItems) { ReadYamlHeader -Path $item.FullName -Verbose:$VerbosePreference; } } } # .ExternalHelp PSDocs-Help.xml function New-PSDocumentOption { [CmdletBinding(DefaultParameterSetName = 'FromPath')] [OutputType([PSDocs.Configuration.PSDocumentOption])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Creates an in memory object only')] param ( [Parameter(Position = 0, Mandatory = $False, ParameterSetName = 'FromPath')] [String]$Path = $PWD, [Parameter(Mandatory = $True, ParameterSetName = 'FromOption')] [PSDocs.Configuration.PSDocumentOption]$Option, [Parameter(Mandatory = $True, ParameterSetName = 'FromDefault')] [Switch]$Default, # Options # Sets the Input.Format option [Parameter(Mandatory = $False)] [Alias('InputFormat')] [ValidateSet('None', 'Yaml', 'Json', 'PowerShellData', 'Detect')] [PSDocs.Configuration.InputFormat]$Format = [PSDocs.Configuration.InputFormat]::Detect, # Sets the Input.ObjectPath option [Parameter(Mandatory = $False)] [String]$InputObjectPath, # Sets the Input.PathIgnore option [Parameter(Mandatory = $False)] [String[]]$InputPathIgnore, # Sets the Markdown.Encoding option [Parameter(Mandatory = $False)] [Alias('MarkdownEncoding')] [PSDocs.Configuration.MarkdownEncoding]$Encoding = [PSDocs.Configuration.MarkdownEncoding]::Default, # Sets the Output.Culture option [Parameter(Mandatory = $False)] [Alias('OutputCulture')] [String[]]$Culture, # Sets the Output.Path option [Parameter(Mandatory = $False)] [String]$OutputPath ) begin { Write-Verbose -Message "[New-PSDocumentOption] BEGIN::"; # Get parameter options, which will override options from other sources $optionParams = @{ }; $optionParams += $PSBoundParameters; # Remove invalid parameters if ($optionParams.ContainsKey('Path')) { $optionParams.Remove('Path'); } if ($optionParams.ContainsKey('Option')) { $optionParams.Remove('Option'); } if ($optionParams.ContainsKey('Default')) { $optionParams.Remove('Default'); } if ($optionParams.ContainsKey('Verbose')) { $optionParams.Remove('Verbose'); } if ($PSBoundParameters.ContainsKey('Option')) { $Option = [PSDocs.Configuration.PSDocumentOption]::FromFileOrEmpty($Option, $Path); } elseif ($PSBoundParameters.ContainsKey('Path')) { Write-Verbose -Message "Attempting to read: $Path"; $Option = [PSDocs.Configuration.PSDocumentOption]::FromFile($Path); } elseif ($PSBoundParameters.ContainsKey('Default')) { $Option = [PSDocs.Configuration.PSDocumentOption]::FromDefault(); } else { Write-Verbose -Message "Attempting to read: $Path"; $Option = [PSDocs.Configuration.PSDocumentOption]::FromFileOrEmpty($Option, $Path); } } end { # Options $Option | SetOptions @optionParams -Verbose:$VerbosePreference; Write-Verbose -Message "[New-PSDocumentOption] END::"; } } #endregion Cmdlets # # Internal language keywords # #region Keywords function Export-PSDocumentConvention { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Position = 0, Mandatory = $True)] [String]$Name, [Parameter(Mandatory = $False)] [ScriptBlock]$Begin, [Parameter(Position = 1, Mandatory = $True)] [ScriptBlock]$Process, [Parameter(Mandatory = $False)] [ScriptBlock]$End ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } # Implement the Document keyword function Document { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Position = 0, Mandatory = $True)] [String]$Name, [Parameter(Mandatory = $False)] [String[]]$Tag, [Parameter(Position = 1, Mandatory = $True)] [ScriptBlock]$Body, [Parameter(Mandatory = $False)] [ScriptBlock]$If, [Parameter(Mandatory = $False)] [String[]]$With ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } # Implement the Section keyword function Section { [CmdletBinding()] [OutputType([PSObject])] param ( # The name of the Section [Parameter(Position = 0, Mandatory = $True)] [String]$Name, # A script block with the body of the Section [Parameter(Position = 1, Mandatory = $True)] [ScriptBlock]$Body, # Optionally a condition that must be met prior to including the Section [Parameter(Mandatory = $False)] [Alias('When')] [ScriptBlock]$If, # Optionally create a section block even when it is empty [Parameter(Mandatory = $False)] [Switch]$Force = $False ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Title { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Position = 0, Mandatory = $True)] [AllowEmptyString()] [String]$Content ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Code { [CmdletBinding()] [OutputType([PSDocs.Models.Code])] param ( # Body of the code block [Parameter(Position = 0, Mandatory = $True, ParameterSetName = 'Default', ValueFromPipeline = $True)] [Parameter(Position = 1, Mandatory = $True, ParameterSetName = 'InfoString', ValueFromPipeline = $True)] [ScriptBlock]$Body, [Parameter(Mandatory = $True, ParameterSetName = 'StringDefault', ValueFromPipeline = $True)] [Parameter(Mandatory = $True, ParameterSetName = 'StringInfoString', ValueFromPipeline = $True)] [String]$BodyString, # Info-string [Parameter(Position = 0, Mandatory = $True, ParameterSetName = 'InfoString')] [Parameter(Position = 0, Mandatory = $True, ParameterSetName = 'StringInfoString')] [String]$Info ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Note { [CmdletBinding(DefaultParameterSetName = 'ScriptBlock')] [OutputType([PSDocs.Models.BlockQuote])] param ( [Parameter(Position = 0, Mandatory = $True, ParameterSetName = 'ScriptBlock')] [ScriptBlock]$Body, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Text')] [String]$Text ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Warning { [CmdletBinding(DefaultParameterSetName = 'ScriptBlock')] [OutputType([PSDocs.Models.BlockQuote])] param ( [Parameter(Position = 0, Mandatory = $True, ParameterSetName = 'ScriptBlock')] [ScriptBlock]$Body, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Text')] [String]$Text ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function BlockQuote { [CmdletBinding()] [OutputType([PSDocs.Models.BlockQuote])] param ( [Parameter(Mandatory = $True, ValueFromPipeline = $True)] [String]$Text, [Parameter(Mandatory = $False)] [String]$Info, [Parameter(Mandatory = $False)] [String]$Title ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Include { [CmdletBinding()] [OutputType([PSDocs.Models.Include])] param ( [Parameter(Position = 0, Mandatory = $True)] [String]$FileName, [Parameter(Mandatory = $False)] [String]$BaseDirectory = $PWD, [Parameter(Mandatory = $False)] [String]$Culture = $Culture, [Parameter(Mandatory = $False)] [Switch]$UseCulture = $False, [Parameter(Mandatory = $False)] [System.Collections.IDictionary]$Replace ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Metadata { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Position = 0, Mandatory = $True)] [AllowNull()] [System.Collections.IDictionary]$Body ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Table { [CmdletBinding()] [OutputType([PSDocs.Models.Table])] param ( [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [AllowNull()] [Object]$InputObject, [Parameter(Mandatory = $False, Position = 0)] [Object[]]$Property ) begin { # This is just a stub to improve authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } #endregion Keywords # # Helper functions # function SetOptions { [CmdletBinding()] [OutputType([PSDocs.Configuration.PSDocumentOption])] param ( [Parameter(Mandatory = $True, ValueFromPipeline = $True)] [PSDocs.Configuration.PSDocumentOption]$InputObject, # Options # Sets the Input.Format option [Parameter(Mandatory = $False)] [Alias('InputFormat')] [ValidateSet('None', 'Yaml', 'Json', 'PowerShellData', 'Detect')] [PSDocs.Configuration.InputFormat]$Format = [PSDocs.Configuration.InputFormat]::Detect, # Sets the Input.ObjectPath option [Parameter(Mandatory = $False)] [String]$InputObjectPath, # Sets the Input.PathIgnore option [Parameter(Mandatory = $False)] [String[]]$InputPathIgnore, # Sets the Markdown.Encoding option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'UTF8', 'UTF7', 'Unicode', 'UTF32', 'ASCII')] [PSDocs.Configuration.MarkdownEncoding]$Encoding = 'Default', # Sets the Output.Culture option [Parameter(Mandatory = $False)] [String[]]$Culture, # Sets the Output.Path option [Parameter(Mandatory = $False)] [String]$OutputPath ) process { # Options # Sets option Input.Format if ($PSBoundParameters.ContainsKey('Format')) { $InputObject.Input.Format = $Format; } # Sets option Input.ObjectPath if ($PSBoundParameters.ContainsKey('InputObjectPath')) { $InputObject.Input.ObjectPath = $InputObjectPath; } # Sets option Input.Encoding if ($PSBoundParameters.ContainsKey('InputPathIgnore')) { $InputObject.Input.PathIgnore = $InputPathIgnore; } # Sets option Markdown.Encoding if ($PSBoundParameters.ContainsKey('Encoding')) { $InputObject.Markdown.Encoding = $Encoding; } # Sets option Output.Culture if ($PSBoundParameters.ContainsKey('Culture')) { $InputObject.Output.Culture = $Culture; } # Sets option Output.Path if ($PSBoundParameters.ContainsKey('OutputPath')) { $InputObject.Output.Path = $OutputPath; } return $InputObject; } } function InitDocumentContext { [CmdletBinding()] param () process { if ($Null -eq (Get-Variable -Name DocumentBody -Scope Script -ErrorAction SilentlyContinue)) { $Script:DocumentBody = @{ }; } } } # Get a list of document script files in the matching paths function GetSource { [CmdletBinding()] [OutputType([PSDocs.Pipeline.Source])] param ( [Parameter(Mandatory = $False)] [String[]]$Path, [Parameter(Mandatory = $False)] [String[]]$Module, [Parameter(Mandatory = $False)] [Switch]$ListAvailable, [Parameter(Mandatory = $False)] [String]$Culture, [Parameter(Mandatory = $False)] [Switch]$PreferPath = $False, [Parameter(Mandatory = $False)] [Switch]$PreferModule = $False, [Parameter(Mandatory = $True)] [PSDocs.Configuration.PSDocumentOption]$Option ) process { $builder = [PSDocs.Pipeline.PipelineBuilder]::Source($Option, $PSCmdlet, $ExecutionContext); if ($PSBoundParameters.ContainsKey('Path')) { try { $builder.Directory($Path); } catch { throw $_.Exception.GetBaseException(); } } $moduleParams = @{}; if ($PSBoundParameters.ContainsKey('Module')) { $moduleParams['Name'] = $Module; # Determine if module should be automatically loaded if (GetAutoloadPreference) { foreach ($m in $Module) { if ($Null -eq (GetModule -Name $m)) { LoadModule -Name $m -Verbose:$VerbosePreference; } } } } if ($PSBoundParameters.ContainsKey('ListAvailable')) { $moduleParams['ListAvailable'] = $ListAvailable.ToBool(); } if ($moduleParams.Count -gt 0 -or $PreferModule) { $modules = @(GetModule @moduleParams); $builder.Module($modules); } $builder.Build(); } } function GetAutoloadPreference { [CmdletBinding()] [OutputType([System.Boolean])] param () process { $v = Microsoft.PowerShell.Utility\Get-Variable -Name 'PSModuleAutoLoadingPreference' -ErrorAction SilentlyContinue; return ($Null -eq $v) -or ($v.Value -eq [System.Management.Automation.PSModuleAutoLoadingPreference]::All); } } function GetModule { [CmdletBinding()] [OutputType([System.Management.Automation.PSModuleInfo])] param ( [Parameter(Mandatory = $False)] [String[]]$Name, [Parameter(Mandatory = $False)] [Switch]$ListAvailable = $False ) process { $moduleResults = (Microsoft.PowerShell.Core\Get-Module @PSBoundParameters | Microsoft.PowerShell.Core\Where-Object -FilterScript { 'PSDocs-documents' -in $_.Tags } | Microsoft.PowerShell.Utility\Group-Object -Property Name) if ($Null -ne $moduleResults) { foreach ($m in $moduleResults) { @($m.Group | Microsoft.PowerShell.Utility\Sort-Object -Descending -Property Version)[0]; } } } } function LoadModule { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True)] [String]$Name ) process{ $Null = GetModule -Name $Name -ListAvailable | Microsoft.PowerShell.Core\Import-Module -Global; } } function ReadYamlHeader { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $True)] [String]$Path ) process { # Read the file $content = Get-Content -Path $Path -Raw; # Detect Yaml header if (![String]::IsNullOrEmpty($content) -and $content -match '^(---(\r|\n|\r\n)(?<yaml>([A-Z0-9]{1,}:[A-Z0-9 ]{1,}(\r|\n|\r\n){0,}){1,})(\r|\n|\r\n)---(\r|\n|\r\n))') { Write-Verbose -Message "[Doc][Toc]`t-- Reading Yaml header: $Path"; # Extract yaml header key value pair [String[]]$yamlHeader = $Matches.yaml -split "`n"; $result = @{ }; # Read key values into hashtable foreach ($item in $yamlHeader) { $kv = $item.Split(':', 2, [System.StringSplitOptions]::RemoveEmptyEntries); Write-Debug -Message "Found yaml keypair from: $item"; if ($kv.Length -eq 2) { $result[$kv[0].Trim()] = $kv[1].Trim(); } } # Emit result to the pipeline return $result; } } } function IsDeviceGuardEnabled { [CmdletBinding()] [OutputType([System.Boolean])] param () process { if ((Get-Variable -Name IsMacOS -ErrorAction Ignore) -or (Get-Variable -Name IsLinux -ErrorAction Ignore)) { return $False; } # PowerShell 6.0.x does not support Device Guard if ($PSVersionTable.PSVersion -ge '6.0' -and $PSVersionTable.PSVersion -lt '6.1') { return $False; } return [System.Management.Automation.Security.SystemPolicy]::GetSystemLockdownPolicy() -eq [System.Management.Automation.Security.SystemEnforcementMode]::Enforce; } } function InitEditorServices { [CmdletBinding()] param () process { Export-ModuleMember -Function @( 'Section' 'Table' 'Metadata' 'Title' 'Code' 'BlockQuote' 'Note' 'Warning' 'Include' 'Export-PSDocumentConvention' ); # Export variables Export-ModuleMember -Variable @( 'PSDocs' ); } } # # Editor services # # Define variables and types [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSDocs.Runtime.PSDocs]$PSDocs = [PSDocs.Runtime.PSDocs]::new(); if ($Null -ne (Get-Variable -Name psEditor -ErrorAction Ignore)) { InitEditorServices; } # # Export module # Export-ModuleMember -Function @( 'Document' 'Invoke-PSDocument' 'Get-PSDocument' 'Get-PSDocumentHeader' 'New-PSDocumentOption' ); # EOM |