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

87 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2024-01-25 13:37:12 +01:00
Script: *count-lines-of-code.ps1*
========================
2022-11-17 19:46:02 +01:00
2023-10-19 08:12:00 +02:00
This PowerShell script counts the number of code lines in source code files (.c/.h/.cpp/.hpp/.java/.ps1/.txt/.md) within a directory tree.
2022-11-17 19:46:02 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2022-11-17 19:46:02 +01:00
```powershell
2023-09-13 09:49:05 +02:00
PS> ./count-lines-of-code.ps1 [[-path] <String>] [<CommonParameters>]
2022-11-17 19:46:02 +01:00
2023-09-13 09:49:05 +02:00
-path <String>
2023-09-20 17:05:11 +02:00
Specifies the path to the directory tree.
2022-11-17 19:46:02 +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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2022-11-17 19:46:02 +01:00
```powershell
2023-10-19 08:12:00 +02:00
PS> ./count-lines-of-code.ps1 cmake
✔️ 📂cmake has 11411 source code files with 639921 lines of code (LOC, took 34 sec)
2022-11-17 19:46:02 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2023-07-29 10:04:38 +02:00
Related Links
-------------
2022-11-17 19:46:02 +01:00
https://github.com/fleschutz/PowerShell
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-09-13 09:49:05 +02:00
Counts the lines of code (LOC)
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-10-19 08:12:00 +02:00
This PowerShell script counts the number of code lines in source code files (.c/.h/.cpp/.hpp/.java/.ps1/.txt/.md) within a directory tree.
2023-09-13 09:49:05 +02:00
.PARAMETER path
2023-09-20 17:05:11 +02:00
Specifies the path to the directory tree.
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-10-19 08:12:00 +02:00
PS> ./count-lines-of-code.ps1 cmake
✔️ 📂cmake has 11411 source code files with 639921 lines of code (LOC, took 34 sec)
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-09-13 09:49:05 +02:00
param([string]$path = "")
2022-11-17 20:02:26 +01:00
try {
2023-09-20 17:05:11 +02:00
if ($path -eq "" ) { $path = Read-Host "Enter the path to the directory tree" }
2022-11-17 20:02:26 +01:00
2023-12-07 20:24:45 +01:00
Write-Progress "Counting lines.."
2023-09-20 17:05:11 +02:00
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2023-09-13 09:49:05 +02:00
$path = Resolve-Path "$path"
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
[int64]$files = [int64]$LOC = 0
Get-ChildItem -Path $path -Include *.c,*.h,*.cpp,*.hpp,*.java,*.ps1,*.txt,*.md -Recurse | ForEach-Object {
$LOC += (Get-Content $_.FullName | Measure-Object -line).Lines
2023-09-20 17:05:11 +02:00
$files++
2022-11-17 20:02:26 +01:00
}
2023-09-20 17:05:11 +02:00
$folderName = (Get-Item "$path").Name
2023-10-19 08:12:00 +02:00
Write-Progress -completed " "
2023-09-20 17:05:11 +02:00
[int]$Elapsed = $stopWatch.Elapsed.TotalSeconds
2023-10-19 08:12:00 +02:00
"✔️ 📂$folderName has $files source code files with $LOC lines of code (LOC, took $Elapsed sec)"
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
2024-03-27 17:36:59 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of count-lines-of-code.ps1 as of 03/27/2024 17:36:26)*