22
33Custom PowerShell git aliases and tab completion helpers on top of ` posh-git ` and ` git-aliases ` .
44
5- ## Install from PowerShell Gallery
5+ ## Module installation
6+
7+ Install from PowerShell Gallery:
68
79``` powershell
810Install-Module GitAliases.Extras -Scope CurrentUser
911Import-Module GitAliases.Extras
1012```
1113
12- ## Install from source
14+ Install from source:
1315
1416``` powershell
1517git clone https://github.com/PhysShell/GitAliases.Extras.git "$HOME\Documents\PowerShell\Modules\GitAliases.Extras"
1618Import-Module GitAliases.Extras
1719```
1820
19- ## Prerequisites
20-
21- - ` git `
22- - ` posh-git `
23- - ` git-aliases `
24-
25- Example bootstrap:
21+ Install dependencies:
2622
2723``` powershell
2824Install-Module posh-git -Scope CurrentUser -Force
2925Install-Module git-aliases -Scope CurrentUser -Force
3026Install-Module GitAliases.Extras -Scope CurrentUser -Force
3127```
3228
33- ## Local quality checks
29+ ## Quality checks
30+
31+ Run both lint and tests:
3432
3533``` powershell
3634.\tools\ci.ps1
3735```
3836
37+ Run only lint:
38+
39+ ``` powershell
40+ .\tools\ci.ps1 -LintOnly
41+ ```
42+
43+ Run only tests:
44+
45+ ``` powershell
46+ .\tools\ci.ps1 -TestOnly
47+ ```
48+
49+ ## Commit hooks
50+
51+ Install local git hooks:
52+
53+ ``` powershell
54+ .\tools\install-hooks.ps1
55+ ```
56+
57+ Installed hooks:
58+ - ` pre-commit ` (lightweight no-op)
59+ - ` commit-msg ` (runs ` tools/ci.ps1 ` )
60+
61+ Checks are skipped when:
62+ - commit message contains ` [skip precommit hook] ` or ` [skip pch] `
63+ - there are no working tree changes (for example, ` git commit --allow-empty ... ` )
64+
3965## Publishing
4066
4167This repository includes:
@@ -49,6 +75,14 @@ To publish from CI:
49752 . Bump ` ModuleVersion ` in ` GitAliases.Extras.psd1 ` .
50763 . Push a tag ` v<ModuleVersion> ` (for example, ` v0.1.0 ` ) or run the publish workflow manually.
5177
78+ ## What CI checks
79+
80+ - ` PSScriptAnalyzer ` linting with ` PSScriptAnalyzerSettings.psd1 `
81+ - ` Pester ` tests in ` tests\ `
82+ - GitHub Actions matrix on:
83+ - Windows PowerShell
84+ - PowerShell 7
85+
5286## License
5387
5488WTFPL. See ` LICENSE ` .
0 commit comments