PowerShell/Docs/list-scripts.md

63 lines
1.4 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*list-scripts.ps1*
================
2022-11-17 20:02:26 +01:00
list-scripts.ps1
2021-10-17 14:33:27 +02:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-10-17 14:33:27 +02:00
```powershell
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-05-26 12:20:18 +02:00
Lists all PowerShell scripts
2022-11-17 20:02:26 +01:00
.DESCRIPTION
This PowerShell script lists all PowerShell scripts in the repository (sorted alphabetically).
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./list-scripts.ps1
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
function ListScripts { param([string]$FilePath)
2023-05-26 12:20:18 +02:00
Write-Progress "Reading $FilePath..."
$table = Import-CSV "$FilePath"
[int]$No = 1
foreach($row in $table) {
2022-11-17 20:02:26 +01:00
New-Object PSObject -Property @{
2023-05-26 12:20:18 +02:00
'No' = $No++
'Script' = $row.SCRIPT
'Description' = $row.DESCRIPTION
2022-11-17 20:02:26 +01:00
}
}
$global:NumScripts = $Table.Count
2023-05-26 12:20:18 +02:00
Write-Progress -completed "."
2022-11-17 20:02:26 +01:00
}
try {
2023-09-01 17:53:03 +02:00
# ListScripts "$PSScriptRoot/../Data/scripts.csv" | Format-Table -property No,Script,Description
$files = Get-ChildItem -path "./*.ps1" -attributes !Directory
foreach ($file in $files) {
$help = Get-Help $file -full
Write-Output "$($file.Name),$($help.Synopsis),"
}
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-09-01 17:53:03 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of list-scripts.ps1 as of 09/01/2023 17:51:52)*