PowerShell/docs/list-dir-tree.md
2024-01-03 12:11:22 +01:00

3.1 KiB

list-dir-tree.ps1

This PowerShell script lists all files and folders in a neat directory tree (including icon and size).

Parameters

PS> ./list-dir-tree.ps1 [[-Path] <String>] [<CommonParameters>]

-Path <String>
    Specifies the path to the directory tree
    
    Required?                    false
    Position?                    1
    Default value                "$PWD"
    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

PS> ./list-dir-tree.ps1 C:\MyFolder
├📂Results
 ├📄sales.txt (442K)
(2 folders, 1 file, 442K file size in total)

Notes

Author: Markus Fleschutz | License: CC0

https://github.com/fleschutz/PowerShell

Script Content

<#
.SYNOPSIS
	Lists a directory tree
.DESCRIPTION
	This PowerShell script lists all files and folders in a neat directory tree (including icon and size).
.PARAMETER Path
	Specifies the path to the directory tree
.EXAMPLE
	PS> ./list-dir-tree.ps1 C:\MyFolder
	├📂Results
	│ ├📄sales.txt (442K)
	(2 folders, 1 file, 442K file size in total)
.LINK
	https://github.com/fleschutz/PowerShell
.NOTES
	Author: Markus Fleschutz | License: CC0
#>

param([string]$Path = "$PWD")

function GetFileIcon([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 Bytes2String([int64]$bytes) {
	if ($bytes -lt 1000) { return "$bytes bytes" }
	$bytes /= 1000
	if ($bytes -lt 1000) { return "$($bytes)K" }
	$bytes /= 1000
        if ($bytes -lt 1000) { return "$($bytes)MB" }
        $bytes /= 1000
        if ($bytes -lt 1000) { return "$($bytes)GB" }
        $bytes /= 1000
	return "$($Bytes)TB"
}

function ListDirectory([string]$path, [int]$depth) {
	$depth++
	$items = Get-ChildItem -path $path
	foreach($item in $items) {
		$filename = $item.Name
		for ($i = 1; $i -lt $depth; $i++) { Write-Host "│ " -noNewline }
		if ($item.Mode -like "d*") {
			Write-Output "├📂$Filename"
			ListDirectory "$path\$filename" $depth
			$global:folders++
		} else {
			$icon = GetFileIcon $item.Extension
			Write-Output "├$($icon)$filename ($(Bytes2String $item.Length))"
			$global:files++
			$global:bytes += $item.Length
		}
	}
}

try {
	[int64]$global:folders = 1
	[int64]$global:files = 0
	[int64]$global:bytes = 0
	ListDirectory $Path 0
	Write-Output " ($($global:folders) folders, $($global:files) files, $(Bytes2String $global:bytes) file size in total)"
	exit 0 # success
} catch {
	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
	exit 1
}

(generated by convert-ps2md.ps1 using the comment-based help of list-dir-tree.ps1 as of 01/03/2024 12:10:47)