-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c0dfc48
commit ce272c1
Showing
1 changed file
with
110 additions
and
110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,110 +1,110 @@ | ||
| <# | ||
| .SYNOPSIS | ||
| This script updates the comment block in the CIPP standard files. | ||
| .DESCRIPTION | ||
| The script reads the standards.json file and updates the comment block in the corresponding CIPP standard files. | ||
| It adds or modifies the comment block based on the properties defined in the standards.json file. | ||
| This is made to be able to generate the help documentation for the CIPP standards automatically. | ||
| .INPUTS | ||
| None. You cannot pipe objects to this script. | ||
| .OUTPUTS | ||
| None. The script modifies the CIPP standard files directly. | ||
| .EXAMPLE | ||
| Update-StandardsComments.ps1 | ||
| This example runs the script to update the comment block in the CIPP standard files. | ||
| #> | ||
| param ( | ||
| [switch]$WhatIf | ||
| ) | ||
|
|
||
| # Find the paths to the standards.json file based on the current script path | ||
| $StandardsJSONPath = Split-Path (Split-Path $PSScriptRoot) | ||
| $StandardsJSONPath = Resolve-Path "$StandardsJSONPath\*\src\data\standards.json" | ||
| $StandardsInfo = Get-Content -Path $StandardsJSONPath | ConvertFrom-Json -Depth 10 | ||
|
|
||
| foreach ($Standard in $StandardsInfo) { | ||
|
|
||
| # Calculate the standards file name and path | ||
| $StandardFileName = $Standard.name -replace 'standards.', 'Invoke-CIPPStandard' | ||
| $StandardsFilePath = Resolve-Path "$(Split-Path $PSScriptRoot)\Modules\CIPPCore\Public\Standards\$StandardFileName.ps1" | ||
| if (-not (Test-Path $StandardsFilePath)) { | ||
| Write-Host "No file found for standard $($Standard.name)" -ForegroundColor Yellow | ||
| continue | ||
| } | ||
| $Content = (Get-Content -Path $StandardsFilePath -Raw).TrimEnd() + "`r`n" | ||
|
|
||
| # Remove random newlines before the param block | ||
| $regexPattern = '#>\s*\r?\n\s*\r?\n\s*param' | ||
| $Content = $Content -replace $regexPattern, "#>`r`n`r`n param" | ||
|
|
||
| # Regex to match the existing comment block | ||
| $Regex = '<#(.|\n)*?\.FUNCTIONALITY\s*Internal(.|\n)*?#>' | ||
|
|
||
| if ($Content -match $Regex) { | ||
| $NewComment = [System.Collections.Generic.List[string]]::new() | ||
| # Add the initial scatic comments | ||
| $NewComment.Add("<#`r`n") | ||
| $NewComment.Add(" .FUNCTIONALITY`r`n") | ||
| $NewComment.Add(" Internal`r`n") | ||
| $NewComment.Add(" .COMPONENT`r`n") | ||
| $NewComment.Add(" (APIName) $($Standard.name -replace 'standards.', '')`r`n") | ||
| $NewComment.Add(" .SYNOPSIS`r`n") | ||
| $NewComment.Add(" (Label) $($Standard.label.ToString())`r`n") | ||
| $NewComment.Add(" .DESCRIPTION`r`n") | ||
| if ([string]::IsNullOrWhiteSpace($Standard.docsDescription)) { | ||
| $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") | ||
| $NewComment.Add(" (DocsDescription) $($Standard.helpText.ToString())`r`n") | ||
| } else { | ||
| $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") | ||
| $NewComment.Add(" (DocsDescription) $($Standard.docsDescription.ToString())`r`n") | ||
| } | ||
| $NewComment.Add(" .NOTES`r`n") | ||
|
|
||
| # Loop through the rest of the properties of the standard and add them to the NOTES field | ||
| foreach ($Property in $Standard.PSObject.Properties) { | ||
| switch ($Property.Name) { | ||
| 'name' { continue } | ||
| 'impactColour' { continue } | ||
| 'docsDescription' { continue } | ||
| 'helpText' { continue } | ||
| 'label' { continue } | ||
| Default { | ||
| $NewComment.Add(" $($Property.Name.ToUpper())`r`n") | ||
| if ($Property.Value -is [System.Object[]]) { | ||
| foreach ($Value in $Property.Value) { | ||
| $NewComment.Add(" $(ConvertTo-Json -InputObject $Value -Depth 5 -Compress)`r`n") | ||
| } | ||
| continue | ||
| } | ||
| $NewComment.Add(" $($Property.Value.ToString())`r`n") | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| # Add header about how to update the comment block with this script | ||
| $NewComment.Add(" UPDATECOMMENTBLOCK`r`n") | ||
| $NewComment.Add(" Run the Tools\Update-StandardsComments.ps1 script to update this comment block`r`n") | ||
| # -Online help link | ||
| $NewComment.Add(" .LINK`r`n") | ||
| $NewComment.Add(" https://docs.cipp.app/user-documentation/tenant/standards/edit-standards`r`n") | ||
| $NewComment.Add(' #>') | ||
|
|
||
| # Write the new comment block to the file | ||
| if ($WhatIf.IsPresent) { | ||
| Write-Host "Would update $StandardsFilePath with the following comment block:" | ||
| $NewComment | ||
| } else { | ||
| $Content -replace $Regex, $NewComment | Set-Content -Path $StandardsFilePath -Encoding utf8 -NoNewLine | ||
| } | ||
| } else { | ||
| Write-Host "No comment block found in $StandardsFilePath" -ForegroundColor Yellow | ||
| } | ||
| } | ||
| <# | ||
| .SYNOPSIS | ||
| This script updates the comment block in the CIPP standard files. | ||
| .DESCRIPTION | ||
| The script reads the standards.json file and updates the comment block in the corresponding CIPP standard files. | ||
| It adds or modifies the comment block based on the properties defined in the standards.json file. | ||
| This is made to be able to generate the help documentation for the CIPP standards automatically. | ||
| .INPUTS | ||
| None. You cannot pipe objects to this script. | ||
| .OUTPUTS | ||
| None. The script modifies the CIPP standard files directly. | ||
| .EXAMPLE | ||
| Update-StandardsComments.ps1 | ||
| This example runs the script to update the comment block in the CIPP standard files. | ||
| #> | ||
| param ( | ||
| [switch]$WhatIf | ||
| ) | ||
|
|
||
| # Find the paths to the standards.json file based on the current script path | ||
| $StandardsJSONPath = Split-Path (Split-Path $PSScriptRoot) | ||
| $StandardsJSONPath = Resolve-Path "$StandardsJSONPath\*\src\data\standards.json" | ||
| $StandardsInfo = Get-Content -Path $StandardsJSONPath | ConvertFrom-Json -Depth 10 | ||
|
|
||
| foreach ($Standard in $StandardsInfo) { | ||
|
|
||
| # Calculate the standards file name and path | ||
| $StandardFileName = $Standard.name -replace 'standards.', 'Invoke-CIPPStandard' | ||
| $StandardsFilePath = Resolve-Path "$(Split-Path $PSScriptRoot)\Modules\CIPPCore\Public\Standards\$StandardFileName.ps1" | ||
| if (-not (Test-Path $StandardsFilePath)) { | ||
| Write-Host "No file found for standard $($Standard.name)" -ForegroundColor Yellow | ||
| continue | ||
| } | ||
| $Content = (Get-Content -Path $StandardsFilePath -Raw).TrimEnd() + "`r`n" | ||
|
|
||
| # Remove random newlines before the param block | ||
| $regexPattern = '#>\s*\r?\n\s*\r?\n\s*param' | ||
| $Content = $Content -replace $regexPattern, "#>`r`n`r`n param" | ||
|
|
||
| # Regex to match the existing comment block | ||
| $Regex = '<#(.|\n)*?\.FUNCTIONALITY\s*Internal(.|\n)*?#>' | ||
|
|
||
| if ($Content -match $Regex) { | ||
| $NewComment = [System.Collections.Generic.List[string]]::new() | ||
| # Add the initial scatic comments | ||
| $NewComment.Add("<#`r`n") | ||
| $NewComment.Add(" .FUNCTIONALITY`r`n") | ||
| $NewComment.Add(" Internal`r`n") | ||
| $NewComment.Add(" .COMPONENT`r`n") | ||
| $NewComment.Add(" (APIName) $($Standard.name -replace 'standards.', '')`r`n") | ||
| $NewComment.Add(" .SYNOPSIS`r`n") | ||
| $NewComment.Add(" (Label) $($Standard.label.ToString())`r`n") | ||
| $NewComment.Add(" .DESCRIPTION`r`n") | ||
| if ([string]::IsNullOrWhiteSpace($Standard.docsDescription)) { | ||
| $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") | ||
| $NewComment.Add(" (DocsDescription) $($Standard.helpText.ToString())`r`n") | ||
| } else { | ||
| $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n") | ||
| $NewComment.Add(" (DocsDescription) $($Standard.docsDescription.ToString())`r`n") | ||
| } | ||
| $NewComment.Add(" .NOTES`r`n") | ||
|
|
||
| # Loop through the rest of the properties of the standard and add them to the NOTES field | ||
| foreach ($Property in $Standard.PSObject.Properties) { | ||
| switch ($Property.Name) { | ||
| 'name' { continue } | ||
| 'impactColour' { continue } | ||
| 'docsDescription' { continue } | ||
| 'helpText' { continue } | ||
| 'label' { continue } | ||
| Default { | ||
| $NewComment.Add(" $($Property.Name.ToUpper())`r`n") | ||
| if ($Property.Value -is [System.Object[]]) { | ||
| foreach ($Value in $Property.Value) { | ||
| $NewComment.Add(" $(ConvertTo-Json -InputObject $Value -Depth 5 -Compress)`r`n") | ||
| } | ||
| continue | ||
| } | ||
| $NewComment.Add(" $($Property.Value.ToString())`r`n") | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| # Add header about how to update the comment block with this script | ||
| $NewComment.Add(" UPDATECOMMENTBLOCK`r`n") | ||
| $NewComment.Add(" Run the Tools\Update-StandardsComments.ps1 script to update this comment block`r`n") | ||
| # -Online help link | ||
| $NewComment.Add(" .LINK`r`n") | ||
| $NewComment.Add(" https://docs.cipp.app/user-documentation/tenant/standards/edit-standards`r`n") | ||
| $NewComment.Add(' #>') | ||
|
|
||
| # Write the new comment block to the file | ||
| if ($WhatIf.IsPresent) { | ||
| Write-Host "Would update $StandardsFilePath with the following comment block:" | ||
| $NewComment | ||
| } else { | ||
| $Content -replace $Regex, $NewComment | Set-Content -Path $StandardsFilePath -Encoding utf8 -NoNewLine | ||
| } | ||
| } else { | ||
| Write-Host "No comment block found in $StandardsFilePath" -ForegroundColor Yellow | ||
| } | ||
| } |