PowerShell/Docs/count-lines-of-code.md

count-lines-of-code.ps1

This PowerShell script counts the number of code lines in a directory tree.

Parameters

PS> ./count-lines-of-code.ps1 [[-path] <String>] [<CommonParameters>]

-path <String>
    Specifies the path to the directory tree.
    
    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

PS> ./count-lines-of-code.ps1 .
✔️ 19765 lines of code (LOC) in 578 files in 📂Scripts (it took 1 sec)

Notes

Author: Markus Fleschutz | License: CC0

Related Links

https://github.com/fleschutz/PowerShell

Script Content

<#
.SYNOPSIS
	Counts the lines of code (LOC)
.DESCRIPTION
	This PowerShell script counts the number of code lines in a directory tree.
.PARAMETER path
	Specifies the path to the directory tree.
.EXAMPLE
	PS> ./count-lines-of-code.ps1 .
	✔️ 19765 lines of code (LOC) in 578 files in 📂Scripts (it took 1 sec)
.LINK
	https://github.com/fleschutz/PowerShell
.NOTES
	Author: Markus Fleschutz | License: CC0
#>

param([string]$path = "")

try {
	if ($path -eq "" ) { $path = Read-Host "Enter the path to the directory tree" }

	$stopWatch = [system.diagnostics.stopwatch]::startNew()
	$path = Resolve-Path "$path"

	Write-Progress "⏳ Counting lines of code in 📂$path ..."
	[int]$files = [int]$LOC = 0
	Get-ChildItem -Path $path -Include *.c,*.h,*.cpp,*.hpp,*.java,*.ps1 -Recurse | ForEach-Object {
		$fileStats = Get-Content $_.FullName | Measure-Object -line
		$LOC += $fileStats.Lines
		$files++
	}
	Write-Progress -completed "."

	$folderName = (Get-Item "$path").Name
	[int]$Elapsed = $stopWatch.Elapsed.TotalSeconds
	"✔️ $LOC lines of code (LOC) in $files files in 📂$folderName (took $Elapsed sec)" 
	exit 0 # success
} catch {
	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
	exit 1
}

(generated by convert-ps2md.ps1 using the comment-based help of count-lines-of-code.ps1 as of 09/20/2023 17:04:39)