utilities/tools/platform/Set-ModuleOverviewTable.ps1


<#
.SYNOPSIS
Update the module overview table in the given markdown file

.DESCRIPTION
Update the module overview table in the given markdown file

.PARAMETER markdownFilePath
Mandatory. The path to the markdown file to update.

.PARAMETER moduleFolderPath
Mandatory. The path to the modules folder.

.PARAMETER RepositoryName
Mandatory. The name of the repository the code resides in. Required for the status badges

.PARAMETER Organization
Mandatory. The name of the Organization the code resides in. Required for the status badges

.PARAMETER Environment
Mandatory. The DevOps environment to generate the status badges for. Required for the status badges

.PARAMETER ProjectName
Optional. The project the repository is hosted in. Required for the status badges and if the 'environment' is 'ADO'

.EXAMPLE
Set-ModuleOverviewTable -markdownFilePath './docs/wiki/The library - Module overview.md' -moduleFolderPath './modules'

Update the file 'The library - Module overview.md' based on the modules in path './modules'
#>
function Set-ModuleOverviewTable {

    [CmdletBinding(SupportsShouldProcess)]
    param (
        [Parameter(Mandatory = $true)]
        [string] $markdownFilePath,

        [Parameter(Mandatory = $true)]
        [string] $moduleFolderPath,

        [Parameter(Mandatory = $false)]
        [ValidateSet('GitHub', 'ADO')]
        [string] $Environment,

        [Parameter(Mandatory = $false)]
        [string] $RepositoryName,

        [Parameter(Mandatory = $false)]
        [string] $Organization,

        [Parameter(Mandatory = $false)]
        [string] $ProjectName = ''
    )

    # Load external functions
    $utilitiesRoot = Split-Path (Split-Path $PSScriptRoot)
    . (Join-Path $utilitiesRoot 'pipelines' 'sharedScripts' 'helper' 'Merge-FileWithNewContent.ps1')
    . (Join-Path $utilitiesRoot 'tools' 'Get-ModulesFeatureOutline.ps1')

    # Logic
    $originalContentArray = Get-Content -Path $markdownFilePath

    $functionInput = @{
        ModuleFolderPath = $moduleFolderPath
        ReturnMarkdown   = $true
        OnlyTopLevel     = $true
        AddStatusBadges  = $true
        Environment      = $Environment
        RepositoryName   = $RepositoryName
        Organization     = $Organization
        ProjectName      = $ProjectName
    }
    $featureTableString = Get-ModulesFeatureOutline @functionInput -Verbose

    $newContent = Merge-FileWithNewContent -oldContent $originalContentArray -newContent $featureTableString.TrimEnd() -sectionStartIdentifier '# Feature table' -contentType 'table'

    Write-Verbose 'New content:'
    Write-Verbose '============'
    Write-Verbose ($newContent | Out-String)

    if ($PSCmdlet.ShouldProcess("File in path [$markdownFilePath]", 'Overwrite')) {
        Set-Content -Path $markdownFilePath -Value $newContent -Force
        Write-Verbose "File [$markdownFilePath] updated" -Verbose
    }
}