RuleToc.Doc.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

Document 'module' {
    Title 'Rules by category'

    Import-Module .\out\modules\PSRule.Rules.GitHub
    $rules = Get-PSRule -Module PSRule.Rules.GitHub -Baseline Azure.All -WarningAction SilentlyContinue |
        Add-Member -MemberType ScriptProperty -Name Category -Value { $this.Info.Annotations.category } -PassThru |
        Sort-Object -Property Category;

    Section 'Baselines' {
        # 'The following baselines are included within `PSRule.Rules.GitHub`.'
    }

    Section 'Rules' {
        'The following rules are included within `PSRule.Rules.GitHub`.'

        $categories = $rules | Group-Object -Property Category;

        foreach ($category in $categories) {
            Section "$($category.Name)" {
                $category.Group |
                    Sort-Object -Property RuleName |
                    Table -Property @{ Name = 'Name'; Expression = {
                        "[$($_.RuleName)]($($_.RuleName).md)"
                    }}, Synopsis, @{ Name = 'Severity'; Expression = {
                        $_.Info.Annotations.severity
                    }}
            }
        }
    }
}

# Document 'resource' {
#     Title 'Rules by resource'

#     Import-Module .\out\modules\PSRule.Rules.GitHub
#     $rules = Get-PSRule -Module PSRule.Rules.GitHub -Baseline GitHub -WarningAction SilentlyContinue |
#         Add-Member -MemberType ScriptProperty -Name Resource -Value { $this.Info.Annotations.resource } -PassThru |
#         Sort-Object -Property Resource;

#     Section 'Rules' {
#         'The following rules are included within `PSRule.Rules.GitHub`.'

#         $resources = $rules | Group-Object -Property Resource;

#         foreach ($resource in $resources) {
#             Section "$($resource.Name)" {
#                 $resource.Group |
#                     Sort-Object -Property RuleName |
#                     Table -Property @{ Name = 'Name'; Expression = {
#                         "[$($_.RuleName)]($($_.RuleName).md)"
#                     }}, Synopsis, @{ Name = 'Severity'; Expression = {
#                         $_.Info.Annotations.severity
#                     }}
#             }
#         }
#     }
# }