PowerShell/Docs/list-folder.md

89 lines
2.2 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *list-folder.ps1* Script
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
This PowerShell script lists the content of a directory (alphabetically formatted in columns).
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/list-folder.ps1 [[-searchPattern] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
-searchPattern <String>
Specifies the search pattern ("*" by default which means anything)
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
Default value *
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
2023-05-26 12:20:18 +02:00
PS> ./list-folder C:\*
2021-11-08 21:36:42 +01:00
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
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 a folder
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-05-26 12:20:18 +02:00
This PowerShell script lists the content of a directory (alphabetically formatted in columns).
2022-11-17 20:02:26 +01:00
.PARAMETER SearchPattern
2023-05-26 12:20:18 +02:00
Specifies the search pattern ("*" by default which means anything)
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-05-26 12:20:18 +02:00
PS> ./list-folder C:\*
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-05-26 12:20:18 +02:00
param([string]$searchPattern = "*")
2022-11-17 20:02:26 +01:00
2023-05-26 12:20:18 +02:00
function GetFileIcon { param([string]$suffix)
switch ($suffix) {
".csv" {return "📊"}
".epub" {return "📓"}
".exe" {return "⚙️"}
".gif" {return "📸"}
".iso" {return "📀"}
".jpg" {return "📸"}
".mp3" {return "🎵"}
".mkv" {return "🎬"}
".zip" {return "🎁"}
default {return "📄"}
}
}
function ListFolder { param([string]$searchPattern)
$items = Get-ChildItem -path "$searchPattern"
foreach ($item in $items) {
$name = $item.Name
if ($name[0] -eq '.') { continue } # hidden file/dir
if ($item.Mode -like "d*") { $icon = "📂" } else { $icon = GetFileIcon $item.Extension }
New-Object PSObject -property @{ Name = "$icon$name" }
2022-11-17 20:02:26 +01:00
}
}
try {
2023-05-26 12:20:18 +02:00
ListFolder $searchPattern | Format-Wide -autoSize
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
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of list-folder.ps1*