Jump cloud module 1.18.2

PowerShell/Deploy/Build-HelpFiles.ps1

@@ -1,23 +1,164 @@
-. ($PSScriptRoot + '/' + 'Get-Config.ps1')
-###########################################################################
-Write-Host ('[status]Creating/Updating help files')
-$Functions_Public | ForEach-Object {
-    $FunctionName = $_.BaseName
-    $FilePath_Md = $FolderPath_Docs + '/' + $FunctionName + '.md'
-    If (Test-Path -Path:($FilePath_Md))
+Param(
+    [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Name of module')][ValidateNotNullOrEmpty()][System.String]$ModuleName = 'JumpCloud'
+    , [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Path to module root')][ValidateNotNullOrEmpty()][System.String]$ModulePath = (Get-Location).Path # $PSScriptRoot
+    , [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Which parameter set to be used for New-MarkdownHelp')][ValidateNotNullOrEmpty()][ValidateSet('FromCommand', 'FromModule')][System.String]$NewMarkdownHelpParamSet = 'FromCommand'
+    , [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Language locale')][ValidateNotNullOrEmpty()][System.String]$Locale = 'en-US'
+    , [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'For adding comment based help')][ValidateNotNullOrEmpty()][System.Boolean]$AddCommentBasedHelp = $false
+)
+# Define misc. vars
+$FilePath_Psd1 = "$ModulePath/$ModuleName.psd1"
+$FolderPath_Docs = "$ModulePath/Docs"
+$FolderPath_enUS = "$ModulePath/$Locale"
+$FilePath_ModulePagePath = "$FolderPath_Docs/$ModuleName.md"
+Write-Host ("[status]Creating/Updating help files")
+Try
+{
+    Write-Host ("[status]Installing module: PlatyPS")
+    Install-Module -Repository:('PSGallery') -Name:('PlatyPS') -Force
+    # Import module
+    Write-Host ("[status]Importing module: $FilePath_Psd1")
+    Import-Module ($FilePath_Psd1) -Force
+    # Remove existing: .\en-Us\$ModuleName-help.xml and .\en-Us\about_$ModuleName.help.txt
+    Remove-Item -Path:("$FolderPath_enUS/*") -Recurse -Force -Verbose
+    # Get contents of psd1 file
+    $Psd1 = Import-PowerShellDataFile -Path:($FilePath_Psd1)
+    #########################################################
+    ############### Adding Comment based help ###############
+    #########################################################
+    If ($AddCommentBasedHelp)
     {
-        # Write-Host ('Updating: ' + $FunctionName + '.md')
-        Update-MarkdownHelp -Path:($FilePath_Md) -Force -ExcludeDontShow -UpdateInputOutput -UseFullTypeName
+        $FolderPath_Public = "$ModulePath/Public"
+        # Move the help contents from docs files to ps1 files
+        $DocFiles = Get-ChildItem $FolderPath_Docs
+        $DocFiles | ForEach-Object {
+            $file = Get-ChildItem $FolderPath_Public -Filter ($_.BaseName + ".ps1") -Recurse
+            if ($file.FullName)
+            {
+                $help = Get-Help -Name $_.BaseName
+                $content = Get-Content $file.FullName -Raw
+                if ($content -notlike "<#*")
+                {
+                    $synopsis = ".Synopsis`r`n" + ($help.Synopsis).Trim()
+                    $description = ".Description`r`n" + ($help.description.text).Trim()
+                    $examples = $help.examples.example | ForEach-Object {
+                        $Example = $_
+                        $ExampleCode = If ($Example.code -like '*C:\>*')
+                        {
+                            ($Example.code).split(">")[1]
+                        }
+                        Else
+                        {
+                            $Example.code
+                        }
+                        (".Example`r`n" + ($ExampleCode).Trim() + "`r`n`r`n" + ($Example.remarks.text).Trim())
+                    }
+                    $notes = If ($help.alertSet.alert.text) { ".Notes`r`n" + ($help.alertSet.alert.text).Trim() }
+                    $link = If ($help.relatedLinks.navigationLink.uri) { ".Link`r`n" + ($help.relatedLinks.navigationLink.uri).Trim() }
+                    Set-Content $file.FullName -Value "<#", $synopsis, $description, $examples, $notes, $link, "#>"
+                    Add-Content $file.FullName -Value $content
+                }
+            }
+        }
+        # Import module the second time to reload the updated function files
+        Import-Module ($FilePath_Psd1) -Force
+        # Remove doc files
+        Remove-Item -Path:("$FolderPath_Docs/*") -Recurse -Force -Exclude:("about_$ModuleName.md", "$ModuleName.md")
     }
-    Else
+    #########################################################
+    #########################################################
+    # If not exist create: .\Docs\about_$ModuleName.md
+    If (-not (Test-Path -Path:("$($FolderPath_Docs)/about_$($ModuleName).md")))
     {
-        # Write-Host ('Creating: ' + $FunctionName + '.md')
-        New-MarkdownHelp  -Command:($FunctionName) -OutputFolder:($FolderPath_Docs) -Force -ExcludeDontShow -OnlineVersionUrl:($GitHubWikiUrl + $FunctionName) -UseFullTypeName
+        Write-Host ("[status]Creating New-MarkdownAboutHelp")
+        New-MarkdownAboutHelp -OutputFolder:($FolderPath_Docs) -AboutName:($ModuleName)
     }
+    # Creating help files: .\Docs\*.md
+    Write-Host ("[status]Creating help files: .\Docs\*.md")
+    Switch ($NewMarkdownHelpParamSet)
+    {
+        'FromCommand'
+        {
+            $Psd1.FunctionsToExport | ForEach-Object {
+                If (-not (Test-Path -Path:("$($FolderPath_Docs)/$($_).md")))
+                {
+                    $parameters = @{
+                        Command               = $_
+                        Force                 = $true
+                        AlphabeticParamsOrder = $true
+                        OnlineVersionUrl      = "$($Psd1.PrivateData.PSData.ProjectUri)/$($FunctionName)"
+                        OutputFolder          = $FolderPath_Docs
+                        NoMetadata            = $false
+                        UseFullTypeName       = $true
+                        ExcludeDontShow       = $true
+                        # Encoding              = '<Encoding>'
+                        # Session               = '<PSSession>'
+                        # Metadata              = '<Hashtable>'
+                    }
+                    New-MarkdownHelp @parameters
+                }
+            }
+        }
+        'FromModule'
+        {
+            $parameters = @{
+                Module                = $ModuleName
+                Force                 = $true
+                AlphabeticParamsOrder = $true
+                OutputFolder          = $FolderPath_Docs
+                NoMetadata            = $false
+                UseFullTypeName       = $true
+                WithModulePage        = $true
+                ModulePagePath        = $FilePath_ModulePagePath
+                Locale                = $Locale
+                HelpVersion           = $Psd1.ModuleVersion
+                FwLink                = $Psd1.PrivateData.PSData.ProjectUri
+                ExcludeDontShow       = $true
+                # Encoding              = '<Encoding>'
+                # Session               = '<PSSession>'
+                # Metadata              = '<Hashtable>'
+            }
+            New-MarkdownHelp @parameters
+        }
+        Default
+        {
+            Write-Error ("Unknown `$NewMarkdownHelpParamSet value: $NewMarkdownHelpParamSet")
+        }
+    }
+    # Update existing help files
+    $parameters = @{
+        Path                  = $FolderPath_Docs
+        RefreshModulePage     = $true
+        ModulePagePath        = $FilePath_ModulePagePath
+        AlphabeticParamsOrder = $true
+        UseFullTypeName       = $true
+        UpdateInputOutput     = $true
+        Force                 = $true
+        ExcludeDontShow       = $true
+        # LogPath               = "$FolderPath_Docs\PlatyPS.log"
+        # LogAppend             = $true
+        # Encoding              = '<Encoding>'
+        # Session               = '<PSSession>'
+    }
+    Update-MarkdownHelpModule @parameters
+    # Manually updating specific feilds within JumpCloud.md
+    $ModulePageContent = Get-Content -Path:($FilePath_ModulePagePath) -Raw
+    $ModulePageContent = $ModulePageContent.Replace("`r", '')
+    $ModulePageContent = $ModulePageContent.Replace("## Description`n{{ Fill in the Description }}", "## Description`n$($Psd1.Description)")
+    $ModulePageContent = $ModulePageContent.Replace(($ModulePageContent | Select-String -Pattern:([regex]"(Module Name: )(.*?)(\n)")).Matches.Value.Trim(), "Module Name: $($ModuleName)")
+    $ModulePageContent = $ModulePageContent.Replace(($ModulePageContent | Select-String -Pattern:([regex]"(Module Guid: )(.*?)(\n)")).Matches.Value.Trim(), "Module Guid: $($Psd1.Guid)")
+    $ModulePageContent = $ModulePageContent.Replace(($ModulePageContent | Select-String -Pattern:([regex]"(Download Help Link: )(.*?)(\n)")).Matches.Value.Trim(), "Download Help Link: $($Psd1.PrivateData.PSData.ProjectUri)")
+    $ModulePageContent = $ModulePageContent.Replace(($ModulePageContent | Select-String -Pattern:([regex]"(Help Version: )(.*?)(\n)")).Matches.Value.Trim(), "Help Version: $($Psd1.ModuleVersion)")
+    $ModulePageContent = $ModulePageContent.Replace(($ModulePageContent | Select-String -Pattern:([regex]"(Locale: )(.*?)(\n)")).Matches.Value.Trim(), "Locale: $($Locale)")
+    $ModulePageContent | Set-Content -Path:($FilePath_ModulePagePath) -Force
+    # Creating: .\en-Us\$ModuleName-help.xml and .\en-Us\about_$ModuleName.help.txt
+    Write-Host ("[status]Creating: .\en-Us\$ModuleName-help.xml and .\en-Us\about_$ModuleName.help.txt")
+    New-ExternalHelp -Path:($FolderPath_Docs) -OutputPath:($FolderPath_enUS) -Force # -ApplicableTag <String> -Encoding <Encoding> -MaxAboutWidth <Int32> -ErrorLogFile <String> -ShowProgress
 }
-# Create new ExternalHelp file.
-Write-Host ('[status]Creating new external help file')
-New-ExternalHelp -Path:($FolderPath_Docs) -OutputPath:($FolderPath_enUS) -Force
+Catch
+{
+    Write-Error ($_)
+}
+
 
 # Create online versions of the help files in the support.wiki
 # Update docs with links to the online docs for 'Get-Help -online' commands

PowerShell/Deploy/SdkSync/jcapiToSupportSync.ps1

@@ -104,11 +104,12 @@ If (-not [System.String]::IsNullOrEmpty($Modules))
                 remain in their individual files. #>
                     $CommandFilePathContent
                 }
-                $PSScriptInfo = ($FunctionContent | Select-String -Pattern:('(?s)(<#)(.*?)(#>)')).Matches.Value
-                $Params = $FunctionContent | Select-String -Pattern:('(?s)(    \[Parameter)(.*?)(\})') -AllMatches
-                $ParameterContent = ($Params.Matches.Value | Where-Object { $_ -notlike '*DontShow*' -and $_ -notlike '*Limit*' -and $_ -notlike '*Skip*' })
-                $OutputType = ($FunctionContent | Select-String -Pattern:('(\[OutputType)(.*?)(\]\r)')).Matches.Value
-                $CmdletBinding = ($FunctionContent | Select-String -Pattern:('(\[CmdletBinding)(.*?)(\]\r)')).Matches.Value
+                # Extract the sections we want to copy over to our new function.
+                $PSScriptInfo = ($FunctionContent | Select-String -Pattern:([regex]'(?s)(<#)(.*?)(#>)')).Matches.Value
+                $Params = $FunctionContent | Select-String -Pattern:([regex]'(?s)(    \[Parameter)(.*?)(\})') -AllMatches
+                $ParameterContent = ($Params.Matches.Value | Where-Object { $_ -notlike '*DontShow*' -and $_ -notlike '${Limit}' -and $_ -notlike '*${Skip}*' })
+                $OutputType = (($FunctionContent | Select-String -Pattern:([regex]'(\[OutputType)(.*?)(\]\s+)')).Matches.Value).TrimEnd()
+                $CmdletBinding = (($FunctionContent | Select-String -Pattern:([regex]'(\[CmdletBinding)(.*?)(\]\s+)')).Matches.Value).TrimEnd()
                 If (-not [System.String]::IsNullOrEmpty($PSScriptInfo))
                 {
                     $PSScriptInfo = $PSScriptInfo.Replace($SdkPrefix, $JumpCloudModulePrefix)

PowerShell/JumpCloud Module/Docs/Add-JCAssociation.md

@@ -173,9 +173,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ### System.Management.Automation.SwitchParameter
+
 ### System.String[]
+
 ### System.Management.Automation.PSObject
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Add-JCCommandTarget.md

@@ -125,7 +125,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ### System.Object
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Add-JCRadiusReplyAttribute.md

@@ -31,17 +31,7 @@ RADIUS reply attribute conflicts are resolved based on the creation date of the
 Add-JCRadiusReplyAttribute -GroupName "BoulderOffice" -VLAN 24
 ```
 
-By specifying the '-VLAN' parameter three radius attributes are added to the JumpCloud user group 'BoulderOffice'.
-
-These attributes are:
-
-name                    value
-----                    -----
-Tunnel-Medium-Type      IEEE-802
-Tunnel-Type             VLAN
-Tunnel-Private-Group-Id 24
-
-The value specified for the '-VLAN' parameter is populated for the value of **Tunnel-Private-Group-Id**.
+By specifying the '-VLAN' parameter three radius attributes are added to the JumpCloud user group 'BoulderOffice'. The value specified for the '-VLAN' parameter is populated for the value of **Tunnel-Private-Group-Id**.
 
 ### Example 2
 ```powershell
@@ -50,48 +40,19 @@ Add-JCRadiusReplyAttribute -GroupName "BoulderOffice" -VLAN 24 -VLANTag 3
 
 By specifying the '-VLAN' parameter three radius attributes are added to the JumpCloud user group 'BoulderOffice'. The use of '-VLANTag' appends each VLAN attribute name with a colon and the tag number specified.
 
-These attributes are:
-
-name                    value
-----                    -----
-Tunnel-Medium-Type:3      IEEE-802
-Tunnel-Type:3             VLAN
-Tunnel-Private-Group-Id:3 24
-
 ### Example 3
 ```powershell
 Add-JCRadiusReplyAttribute -GroupName "BoulderOffice" -NumberOfAttributes 2 -Attribute1_name "Session-Timeout" -Attribute1_value 100 -Attribute2_name "Termination-Action" -Attribute2_value 1
 ```
 
-Adds two Radius attributes to the JumpCloud user group 'BoulderOffice'.
-
-These attribute are:
-
-name               value
-----               -----
-Session-Timeout    100
-Termination-Action 1
-
-The parameter '-NumberOfAttributes' is a dynamic parameter that generates two required parameters for each custom attribute specified. In this example these parameters are -Attribute1_name,-Attribute1_value, -Attribute2_name and -Attribute2_value.
+Adds two Radius attributes to the JumpCloud user group 'BoulderOffice'. The parameter '-NumberOfAttributes' is a dynamic parameter that generates two required parameters for each custom attribute specified. In this example these parameters are -Attribute1_name,-Attribute1_value, -Attribute2_name and -Attribute2_value.
 
 ### Example 4
 ```powershell
 Add-JCRadiusReplyAttribute -GroupName "BoulderOffice" -VLAN 24 -NumberOfAttributes 2 -Attribute1_name "Session-Timeout" -Attribute1_value 100 -Attribute2_name "Termination-Action" -Attribute2_value 1
 ```
 
-Adds five Radius reply attributes to the JumpCloud User group 'BoulderUsers'
-
-These attributes are:
-
-name                    value
-----                    -----
-Tunnel-Medium-Type      IEEE-802
-Termination-Action      1
-Tunnel-Type             VLAN
-Session-Timeout         100
-Tunnel-Private-Group-Id 24
-
-By specifying the '-VLAN' parameter three radius attributes are added to the JumpCloud user group 'BoulderOffice'. The value specified for the '-VLAN' parameter is populated for the value of **Tunnel-Private-Group-Id**.The parameter '-NumberOfAttributes' is a dynamic parameter that generates two required parameters for each custom attribute specified. In this example these parameters are -Attribute1_name,-Attribute1_value, -Attribute2_name and -Attribute2_value.
+Adds five Radius reply attributes to the JumpCloud User group 'BoulderUsers'. By specifying the '-VLAN' parameter three radius attributes are added to the JumpCloud user group 'BoulderOffice'. The value specified for the '-VLAN' parameter is populated for the value of **Tunnel-Private-Group-Id**.The parameter '-NumberOfAttributes' is a dynamic parameter that generates two required parameters for each custom attribute specified. In this example these parameters are -Attribute1_name,-Attribute1_value, -Attribute2_name and -Attribute2_value.
 
 ## PARAMETERS
 
@@ -241,7 +202,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ### System.Int32
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Add-JCSystemGroupMember.md

@@ -148,6 +148,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Add-JCSystemUser.md

@@ -137,7 +137,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ### System.Boolean
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Add-JCUserGroupMember.md

@@ -164,6 +164,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md

@@ -47,6 +47,22 @@ Using the "-Force" parameter the module update check is skipped. The '-Force' pa
 
 ## PARAMETERS
 
+### -force
+Using the "-Force" parameter the module update check is skipped.
+The '-Force' parameter should be used when using the JumpCloud module in scripts or other automation environments.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -JCEnvironment
 Specific to JumpCloud development team to connect to staging dev environment.
 
@@ -95,28 +111,13 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -force
-Using the "-Force" parameter the module update check is skipped.
-The '-Force' parameter should be used when using the JumpCloud module in scripts or other automation environments.
-
-```yaml
-Type: System.Management.Automation.SwitchParameter
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
 ### System.String
+
 ## OUTPUTS
 
 ### System.Object

PowerShell/JumpCloud Module/Docs/Copy-JCAssociation.md

@@ -189,8 +189,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS
 
 ### System.String
+
 ### System.Management.Automation.SwitchParameter
+
 ### System.String[]
+
 ## OUTPUTS
 
 ### System.Object