Rename folder Docs to docs

2025-08-17 08:01:31 +02:00 · 2023-10-31 11:05:01 +01:00
parent 0915de8f8b
commit 893273739a
900 changed files with 304 additions and 304 deletions
--- a/docs/list-commit-stats.md
+++ b/docs/list-commit-stats.md
@ -0,0 +1,96 @@
+*list-commit-stats.ps1*
+================
+
+This PowerShell script lists the commit statistics of a Git repository.
+
+Parameters
+----------
+```powershell
+PS> ./list-commit-stats.ps1 [[-path] <String>] [<CommonParameters>]
+
+-path <String>
+    Specifies the path to the local Git repository (default is current working dir)
+    
+    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
+-------
+```powershell
+PS> ./list-commit-stats.ps1
+ 
+       Commits Author
+       ------- ------
+   2034 Markus Fleschutz <markus.fleschutz@gmail.com>
+...
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Lists the Git commit statistics
+.DESCRIPTION
+	This PowerShell script lists the commit statistics of a Git repository.
+.PARAMETER path
+	Specifies the path to the local Git repository (default is current working dir)
+.EXAMPLE
+	PS> ./list-commit-stats.ps1
+  
+        Commits Author
+        ------- ------
+	   2034 Markus Fleschutz <markus.fleschutz@gmail.com>
+	...
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+param([string]$path = "$PWD")
+
+try {
+	Write-Progress "⏳ (1/4) Searching for Git executable..."
+	$null = (git --version)
+	if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
+
+	Write-Progress "⏳ (2/4) Checking local Git repository..."
+	if (-not(Test-Path "$path" -pathType container)) { throw "Can't access directory: $path" }
+
+	Write-Progress "⏳ (3/4) Fetching updates..."
+	& git -C "$path" fetch --all --quiet
+	if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
+
+	Write-Progress "⏳ (4/4) Querying commits..."
+	" "
+	"Commits Author"
+	"------- ------"
+	Write-Progress -completed " "
+	git -C "$path" shortlog --summary --numbered --email --no-merges
+	if ($lastExitCode -ne "0") { throw "'git shortlog' failed with exit code $lastExitCode" }
+	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-commit-stats.ps1 as of 10/19/2023 08:11:39)*