Skip to content

Commit 51c05fa

Browse files
committed
Reflect renaming GitAliases.Extra submodule
1 parent 88693ba commit 51c05fa

11 files changed

Lines changed: 49 additions & 35 deletions

.gitmodules

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[submodule "modules/GitAliases.Extras"]
2-
path = modules/GitAliases.Extras
3-
url = git@github.com:PhysShell/GitAliases.Extras.git
1+
[submodule "modules/git-aliases-extra"]
2+
path = modules/git-aliases-extra
3+
url = git@github.com:PhysShell/git-aliases-extra.git
44
branch = main

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# dotfiles
22

3+
## Breaking Changes (2026-02-19)
4+
5+
- Renamed submodule path: `modules/GitAliases.Extras` -> `modules/git-aliases-extra`
6+
- Renamed migration script: `tools/migrate-gitaliases-extras.ps1` -> `tools/migrate-git-aliases-extra.ps1`
7+
- Existing local git hooks may still point to the old path and fail
8+
9+
Migration steps:
10+
11+
```powershell
12+
git submodule sync --recursive
13+
git submodule update --init --recursive
14+
.\tools\install-hooks.ps1
15+
```
16+
317
## Profile installation
418

519
Put this in `$PROFILE.CurrentUserAllHosts`:
@@ -41,28 +55,28 @@ Install local git hooks:
4155
Installed hooks:
4256
- `pre-commit` (lightweight no-op)
4357
- `commit-msg` (runs `tools/ci.ps1`)
44-
- hook logic is sourced from `modules/GitAliases.Extras/tools/hooks/*` to avoid duplication
58+
- hook logic is sourced from `modules/git-aliases-extra/tools/hooks/*` to avoid duplication
4559

4660
Checks are skipped when:
4761
- commit message contains `[skip precommit hook]` or `[skip pch]`
4862
- there are no working tree changes (for example, `git commit --allow-empty ...`)
4963

50-
## Extract GitAliases.Extras
64+
## Extract git-aliases-extra
5165

52-
Recommended approach: keep this as dotfiles repo and move `modules/GitAliases.Extras` to its own repository, then consume it via git submodule at the same path.
66+
Recommended approach: keep this as dotfiles repo and move `modules/git-aliases-extra` to its own repository, then consume it via git submodule at the same path.
5367

5468
Safe migration flow:
5569

5670
1. Run a dry run:
5771

5872
```powershell
59-
.\tools\migrate-gitaliases-extras.ps1 -SubmoduleUrl 'git@github.com:<you>/GitAliases.Extras.git' -SubmoduleBranch main -PushSplit
73+
.\tools\migrate-git-aliases-extra.ps1 -SubmoduleUrl 'git@github.com:<you>/git-aliases-extra.git' -SubmoduleBranch main -PushSplit
6074
```
6175

6276
2. Apply the migration:
6377

6478
```powershell
65-
.\tools\migrate-gitaliases-extras.ps1 -SubmoduleUrl 'git@github.com:<you>/GitAliases.Extras.git' -SubmoduleBranch main -PushSplit -Apply
79+
.\tools\migrate-git-aliases-extra.ps1 -SubmoduleUrl 'git@github.com:<you>/git-aliases-extra.git' -SubmoduleBranch main -PushSplit -Apply
6680
```
6781

6882
3. Commit resulting changes in this repo (`.gitmodules` + submodule pointer).
@@ -71,12 +85,12 @@ Notes:
7185
- `bootstrap.ps1` now initializes submodules automatically if `.gitmodules` exists.
7286
- `profile.ps1` warns with the exact `git submodule update --init --recursive` command if submodules were not initialized.
7387

74-
P.S. You can also install just [GitAliases.Extras](https://github.com/PhysShell/GitAliases.Extras) without dotfiles as standalone powershell package
88+
P.S. You can also install just [git-aliases-extra](https://github.com/PhysShell/git-aliases-extra) without dotfiles as standalone powershell package
7589

7690
## What CI checks
7791

7892
- `PSScriptAnalyzer` linting with `PSScriptAnalyzerSettings.psd1`
79-
- `Pester` tests in `tests\` plus `modules\GitAliases.Extras\tests\`
93+
- `Pester` tests in `tests\` plus `modules\git-aliases-extra\tests\`
8094
- GitHub Actions matrix on:
8195
- Windows PowerShell 5.1
8296
- PowerShell 7

modules/GitAliases.Extras

Lines changed: 0 additions & 1 deletion
This file was deleted.

modules/git-aliases-extra

Submodule git-aliases-extra added at bdbf342

profile.ps1

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ if (Get-Module -ListAvailable -Name PSReadLine) {
4141
}
4242

4343
# --- Add your custom modules directory to the PSModulePath ---
44-
# This ensures PowerShell can find your 'GitAliases.Extras' module.
44+
# This ensures PowerShell can find your 'git-aliases-extra' module.
4545
$dotFilesRoot = Split-Path -Parent $MyInvocation.MyCommand.Path
4646
$dotModules = Join-Path $dotFilesRoot 'modules'
4747
$sep = [IO.Path]::PathSeparator
@@ -64,16 +64,16 @@ if (Get-Command g -CommandType Function -ErrorAction SilentlyContinue) {
6464
}
6565
Set-Alias -Name g -Value git -Force
6666

67-
# 3. GitAliases.Extras: Your custom module that DEPENDS on posh-git.
67+
# 3. git-aliases-extra: Your custom module that DEPENDS on posh-git.
6868
# It finds all aliases and registers the proxy completer.
69-
$extrasManifest = Join-Path $dotFilesRoot 'modules\GitAliases.Extras\GitAliases.Extras.psd1'
70-
if (-not (Get-Module -Name GitAliases.Extras -ErrorAction SilentlyContinue)) {
69+
$extrasManifest = Join-Path $dotFilesRoot 'modules\git-aliases-extra\git-aliases-extra.psd1'
70+
if (-not (Get-Module -Name git-aliases-extra -ErrorAction SilentlyContinue)) {
7171
if (Test-Path -LiteralPath $extrasManifest) {
72-
Import-Module $extrasManifest -ErrorAction Stop
72+
Import-Module $extrasManifest -DisableNameChecking -ErrorAction Stop
7373
} elseif (Test-Path -LiteralPath (Join-Path $dotFilesRoot '.gitmodules')) {
74-
Write-Warning "GitAliases.Extras is missing. Initialize submodules: git -C '$dotFilesRoot' submodule update --init --recursive"
74+
Write-Warning "git-aliases-extra is missing. Initialize submodules: git -C '$dotFilesRoot' submodule update --init --recursive"
7575
} else {
76-
Write-Warning "GitAliases.Extras module not found at '$extrasManifest'."
76+
Write-Warning "git-aliases-extra module not found at '$extrasManifest'."
7777
}
7878
}
7979

tests/GitHooks.Tests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ BeforeAll {
5656
Set-Content -Path '.git/ci-ran' -Value 'ran' -NoNewline -Encoding ascii
5757
'@ | Set-Content -Path $ciScriptPath -Encoding ascii
5858

59-
$moduleHooksPath = Join-Path $repoPath 'modules\GitAliases.Extras\tools\hooks'
59+
$moduleHooksPath = Join-Path $repoPath 'modules\git-aliases-extra\tools\hooks'
6060
New-Item -ItemType Directory -Path $moduleHooksPath -Force | Out-Null
6161
Copy-Item -Path $script:ModulePreCommitHookSource -Destination (Join-Path $moduleHooksPath 'pre-commit') -Force
6262
Copy-Item -Path $script:ModuleCommitMsgHookSource -Destination (Join-Path $moduleHooksPath 'commit-msg') -Force
@@ -80,8 +80,8 @@ Set-Content -Path '.git/ci-ran' -Value 'ran' -NoNewline -Encoding ascii
8080
Select-Object -ExpandProperty Path -First 1
8181
$script:PreCommitHookSource = Join-Path $script:RepoRoot 'tools\hooks\pre-commit'
8282
$script:CommitMsgHookSource = Join-Path $script:RepoRoot 'tools\hooks\commit-msg'
83-
$script:ModulePreCommitHookSource = Join-Path $script:RepoRoot 'modules\GitAliases.Extras\tools\hooks\pre-commit'
84-
$script:ModuleCommitMsgHookSource = Join-Path $script:RepoRoot 'modules\GitAliases.Extras\tools\hooks\commit-msg'
83+
$script:ModulePreCommitHookSource = Join-Path $script:RepoRoot 'modules\git-aliases-extra\tools\hooks\pre-commit'
84+
$script:ModuleCommitMsgHookSource = Join-Path $script:RepoRoot 'modules\git-aliases-extra\tools\hooks\commit-msg'
8585
}
8686

8787
Describe 'commit hooks integration' {

tests/MigrationScript.Tests.ps1

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ BeforeAll {
4242
$tempRoot = Join-Path ([IO.Path]::GetTempPath()) ($Prefix + '-' + [guid]::NewGuid().Guid)
4343
$repoPath = Join-Path $tempRoot 'repo'
4444
$toolsPath = Join-Path $repoPath 'tools'
45-
$modulePath = Join-Path $repoPath 'modules\GitAliases.Extras'
45+
$modulePath = Join-Path $repoPath 'modules\git-aliases-extra'
4646

4747
New-Item -ItemType Directory -Path $toolsPath -Force | Out-Null
4848
New-Item -ItemType Directory -Path $modulePath -Force | Out-Null
4949

50-
Copy-Item -Path $script:MigrationScriptSource -Destination (Join-Path $toolsPath 'migrate-gitaliases-extras.ps1') -Force
50+
Copy-Item -Path $script:MigrationScriptSource -Destination (Join-Path $toolsPath 'migrate-git-aliases-extra.ps1') -Force
5151

5252
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('init') | Out-Null
5353
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('config', 'user.email', 'test@example.com') | Out-Null
5454
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('config', 'user.name', 'Test User') | Out-Null
5555
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('config', 'commit.gpgsign', 'false') | Out-Null
5656

57-
Set-Content -Path (Join-Path $modulePath 'GitAliases.Extras.psm1') -Value "function gsw { 'ok' }" -NoNewline -Encoding ascii
57+
Set-Content -Path (Join-Path $modulePath 'git-aliases-extra.psm1') -Value "function gsw { 'ok' }" -NoNewline -Encoding ascii
5858
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('add', '.') | Out-Null
5959
Invoke-GitForMigrationTests -RepoPath $repoPath -Arguments @('commit', '-m', 'init module') | Out-Null
6060

@@ -66,24 +66,24 @@ BeforeAll {
6666

6767
[string]$script:RepoRoot = Resolve-Path -LiteralPath (Join-Path $PSScriptRoot '..') |
6868
Select-Object -ExpandProperty Path -First 1
69-
$script:MigrationScriptSource = Join-Path $script:RepoRoot 'tools\migrate-gitaliases-extras.ps1'
69+
$script:MigrationScriptSource = Join-Path $script:RepoRoot 'tools\migrate-git-aliases-extra.ps1'
7070
}
7171

72-
Describe 'migrate-gitaliases-extras script' {
72+
Describe 'migrate-git-aliases-extra script' {
7373
It 'dry run succeeds and does not modify repository layout' -Skip:(-not (Get-Command git -ErrorAction SilentlyContinue)) {
7474
$context = New-MigrationTestRepository -Prefix 'migration-dry-run'
7575
try {
7676
Push-Location $context.RepoPath
7777
try {
78-
$output = & pwsh -NoProfile -File '.\tools\migrate-gitaliases-extras.ps1' -SubmoduleUrl 'git@github.com:example/GitAliases.Extras.git' 2>&1
78+
$output = & pwsh -NoProfile -File '.\tools\migrate-git-aliases-extra.ps1' -SubmoduleUrl 'git@github.com:example/git-aliases-extra.git' 2>&1
7979
$exitCode = $LASTEXITCODE
8080
} finally {
8181
Pop-Location
8282
}
8383

8484
$exitCode | Should -Be 0
8585
(($output | Out-String) -match 'Dry run complete') | Should -BeTrue
86-
(Test-Path -LiteralPath (Join-Path $context.RepoPath 'modules\GitAliases.Extras\GitAliases.Extras.psm1')) | Should -BeTrue
86+
(Test-Path -LiteralPath (Join-Path $context.RepoPath 'modules\git-aliases-extra\git-aliases-extra.psm1')) | Should -BeTrue
8787
(Test-Path -LiteralPath (Join-Path $context.RepoPath '.gitmodules')) | Should -BeFalse
8888
} finally {
8989
if (Test-Path -LiteralPath $context.TempRoot) {
@@ -99,7 +99,7 @@ Describe 'migrate-gitaliases-extras script' {
9999

100100
Push-Location $context.RepoPath
101101
try {
102-
$output = & pwsh -NoProfile -File '.\tools\migrate-gitaliases-extras.ps1' -SubmoduleUrl 'git@github.com:example/GitAliases.Extras.git' 2>&1
102+
$output = & pwsh -NoProfile -File '.\tools\migrate-git-aliases-extra.ps1' -SubmoduleUrl 'git@github.com:example/git-aliases-extra.git' 2>&1
103103
$exitCode = $LASTEXITCODE
104104
} finally {
105105
Pop-Location

tools/hooks/commit-msg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/sh
22
set -e
33

4-
module_hook="modules/GitAliases.Extras/tools/hooks/commit-msg"
4+
module_hook="modules/git-aliases-extra/tools/hooks/commit-msg"
55
if [ ! -f "$module_hook" ]; then
66
echo "commit-msg: missing '$module_hook'"
77
echo "Initialize submodules: git submodule update --init --recursive"

tools/hooks/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/sh
22
set -e
33

4-
module_hook="modules/GitAliases.Extras/tools/hooks/pre-commit"
4+
module_hook="modules/git-aliases-extra/tools/hooks/pre-commit"
55
if [ ! -f "$module_hook" ]; then
66
echo "pre-commit: missing '$module_hook'"
77
echo "Initialize submodules: git submodule update --init --recursive"
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ param(
33
[Parameter(Mandatory = $true)]
44
[string]$SubmoduleUrl,
55
[string]$SubmoduleBranch = 'main',
6-
[string]$ModulePath = 'modules/GitAliases.Extras',
6+
[string]$ModulePath = 'modules/git-aliases-extra',
77
[switch]$PushSplit,
88
[switch]$Apply,
99
[switch]$AllowDirty
@@ -72,7 +72,7 @@ if ($PushSplit) {
7272
if (-not $Apply) {
7373
Write-Host ''
7474
Write-Host 'Dry run complete. Next command:'
75-
Write-Host (" .\tools\migrate-gitaliases-extras.ps1 -SubmoduleUrl '{0}' -SubmoduleBranch '{1}' -PushSplit -Apply" -f $SubmoduleUrl, $SubmoduleBranch)
75+
Write-Host (" .\tools\migrate-git-aliases-extra.ps1 -SubmoduleUrl '{0}' -SubmoduleBranch '{1}' -PushSplit -Apply" -f $SubmoduleUrl, $SubmoduleBranch)
7676
Write-Host ''
7777
Write-Host 'This will:'
7878
Write-Host (" 1) keep history via subtree split for {0}" -f $ModulePath)
@@ -94,4 +94,4 @@ Write-Host ''
9494
Write-Host 'Migration completed.'
9595
Write-Host 'Review and commit:'
9696
Write-Host ' git status'
97-
Write-Host " git commit -m 'Extract GitAliases.Extras to submodule'"
97+
Write-Host " git commit -m 'Extract git-aliases-extra to submodule'"

0 commit comments

Comments
 (0)