upstream/icinga-powershell-framework
1
0
Fork 0
mirror of https://github.com/Icinga/icinga-powershell-framework.git synced 2025-12-20 23:00:35 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #471 from Icinga:fix/plugin_doc_generator_newline_table

Browse source 
Fix: New-lines in plugin doc table generator
This commit is contained in:
Lord Hepipud 2022-02-08 09:42:25 +01:00 committed by GitHub
commit c0897c4bce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
lib/core/framework/Publish-IcingaPluginDocumentation.psm1
View file

@ -53,9 +53,17 @@ function Publish-IcingaPluginDocumentation()
$AvailablePlugins = Get-ChildItem -Path $PluginDir -Recurse -Filter *.psm1; $AvailablePlugins = Get-ChildItem -Path $PluginDir -Recurse -Filter *.psm1;
foreach ($plugin in $AvailablePlugins) { foreach ($plugin in $AvailablePlugins) {
[string]$PluginName = $plugin.Name.Replace('.psm1', ''); [string]$PluginName = $plugin.Name.Replace('.psm1', '');
[string]$PluginDocName = ''; [string]$PluginDocName = '';
$PluginDetails = Get-Help -Name $PluginName -Full; [string]$PluginSynopsis = '-';
$PluginDetails = Get-Help -Name $PluginName -Full;
if ($null -ne $PluginDetails -And [string]::IsNullOrEmpty($PluginDetails.Synopsis) -eq $FALSE) {
$PluginSynopsis = $PluginDetails.Synopsis.Replace("`r`n", ' ');
$PluginSynopsis = $PluginSynopsis.Replace("`r", ' ');
$PluginSynopsis = $PluginSynopsis.Replace("`n", ' ');
}
foreach ($DocFile in $MDFiles) { foreach ($DocFile in $MDFiles) {
$DocFileName = $DocFile.Name; $DocFileName = $DocFile.Name;
if ($DocFileName -Like "*$PluginName.md") { if ($DocFileName -Like "*$PluginName.md") {
@ -80,7 +88,7 @@ function Publish-IcingaPluginDocumentation()
'| [{0}](plugins/{1}) | {2} |', '| [{0}](plugins/{1}) | {2} |',
$PluginName, $PluginName,
$PluginDocName, $PluginDocName,
$PluginDetails.Synopsis $PluginSynopsis
)); ));
$PluginHelp = Get-Help $PluginName -Full; $PluginHelp = Get-Help $PluginName -Full;