improve documentation

This commit is contained in:
David Refoua
2025-11-08 17:39:50 +03:30
committed by GitHub
parent f9d402d447
commit 538662ce56
3 changed files with 458 additions and 452 deletions

View File

@@ -354,7 +354,7 @@ However, Cmder can in fact run in a variety of other terminal emulators, and eve
⚠ *Note:* Cmder includes built-in support for Windows Terminal directory tracking via OSC 9;9 sequences. This enables "Duplicate Tab" and "Split Pane" features to preserve the current working directory for both `cmd.exe` and PowerShell sessions. ⚠ *Note:* Cmder includes built-in support for Windows Terminal directory tracking via OSC 9;9 sequences. This enables "Duplicate Tab" and "Split Pane" features to preserve the current working directory for both `cmd.exe` and PowerShell sessions.
⚠ *Note:* Cmder also includes built-in support for Windows Terminal shell integration via OSC 133 sequences (A, B, C) for PowerShell sessions. This enables features like command navigation (jump between commands), command selection, visual command separators, and improved command history management in Windows Terminal. ⚠ *Note:* Cmder also includes built-in support for [Windows Terminal shell integration](https://learn.microsoft.com/en-us/windows/terminal/tutorials/shell-integration) via OSC 133 sequences (A, B, C) for PowerShell sessions. This enables features like command navigation (jump between commands), command selection, visual command separators, and improved command history management in Windows Terminal.
For instructions on how to integrate Cmder with your IDE, please read our [Wiki section](https://github.com/cmderdev/cmder/wiki#cmder-integration). For instructions on how to integrate Cmder with your IDE, please read our [Wiki section](https://github.com/cmderdev/cmder/wiki#cmder-integration).

550
vendor/profile.ps1 vendored
View File

@@ -1,272 +1,278 @@
# Init Script for PowerShell # Init Script for PowerShell
# Created as part of Cmder project # Created as part of Cmder project
# NOTE: This file must be saved using UTF-8 with BOM encoding for prompt symbol to work correctly. # NOTE: This file must be saved using UTF-8 with BOM encoding for prompt symbol to work correctly.
# !!! THIS FILE IS OVERWRITTEN WHEN CMDER IS UPDATED # !!! THIS FILE IS OVERWRITTEN WHEN CMDER IS UPDATED
# !!! Use "%CMDER_ROOT%\config\user_profile.ps1" to add your own startup commands # !!! Use "%CMDER_ROOT%\config\user_profile.ps1" to add your own startup commands
$CMDER_INIT_START = Get-Date $CMDER_INIT_START = Get-Date
# Compatibility with PS major versions <= 2 # Compatibility with PS major versions <= 2
if (!$PSScriptRoot) { if (!$PSScriptRoot) {
$PSScriptRoot = Split-Path $Script:MyInvocation.MyCommand.Path $PSScriptRoot = Split-Path $Script:MyInvocation.MyCommand.Path
} }
if ($ENV:CMDER_USER_CONFIG) { if ($ENV:CMDER_USER_CONFIG) {
Write-Verbose "CMDER IS ALSO USING INDIVIDUAL USER CONFIG FROM '$ENV:CMDER_USER_CONFIG'!" Write-Verbose "CMDER IS ALSO USING INDIVIDUAL USER CONFIG FROM '$ENV:CMDER_USER_CONFIG'!"
} }
# We do this for Powershell as Admin Sessions because CMDER_ROOT is not being set. # We do this for Powershell as Admin Sessions because CMDER_ROOT is not being set.
if (!$ENV:CMDER_ROOT) { if (!$ENV:CMDER_ROOT) {
if ($ENV:ConEmuDir) { if ($ENV:ConEmuDir) {
$ENV:CMDER_ROOT = Resolve-Path($ENV:ConEmuDir + "\..\..") $ENV:CMDER_ROOT = Resolve-Path($ENV:ConEmuDir + "\..\..")
} else { } else {
$ENV:CMDER_ROOT = Resolve-Path($PSScriptRoot + "\..") $ENV:CMDER_ROOT = Resolve-Path($PSScriptRoot + "\..")
} }
} }
# Remove trailing '\' # Remove trailing '\'
$ENV:CMDER_ROOT = ($ENV:CMDER_ROOT).TrimEnd("\") $ENV:CMDER_ROOT = ($ENV:CMDER_ROOT).TrimEnd("\")
# Recent PowerShell versions include PowerShellGet out of the box # Recent PowerShell versions include PowerShellGet out of the box
$moduleInstallerAvailable = [bool](Get-Command -Name 'Install-Module' -ErrorAction SilentlyContinue) $moduleInstallerAvailable = [bool](Get-Command -Name 'Install-Module' -ErrorAction SilentlyContinue)
# Add Cmder modules directory to the autoload path. # Add Cmder modules directory to the autoload path.
$CmderModulePath = Join-path $PSScriptRoot "psmodules/" $CmderModulePath = Join-path $PSScriptRoot "psmodules/"
$CmderFunctions = Join-Path $CmderModulePath "Cmder.ps1" # Import Cmder functions
. $CmderFunctions $CmderFunctions = Join-Path $CmderModulePath "Cmder.ps1"
. $CmderFunctions
if(-not $moduleInstallerAvailable -and -not $env:PSModulePath.Contains($CmderModulePath) ) {
$env:PSModulePath = $env:PSModulePath.Insert(0, "$CmderModulePath;") # Configure PSModulePath to include Cmder modules if not already present
} if (-not $moduleInstallerAvailable -and -not $env:PSModulePath.Contains($CmderModulePath) ) {
$env:PSModulePath = $env:PSModulePath.Insert(0, "$CmderModulePath;")
$gitVersionVendor = (readVersion -gitPath "$ENV:CMDER_ROOT\vendor\git-for-windows\cmd") }
Write-Debug "GIT VENDOR: ${gitVersionVendor}"
# Read vendored Git Version
# Get user installed Git Version[s] and Compare with vendored if found. $gitVersionVendor = (readGitVersion -gitPath "$ENV:CMDER_ROOT\vendor\git-for-windows\cmd")
foreach ($git in (Get-Command -ErrorAction SilentlyContinue 'git')) { Write-Debug "GIT VENDOR: ${gitVersionVendor}"
Write-Debug "GIT PATH: {$git.Path}"
$gitDir = Split-Path -Path $git.Path # Get user installed Git version(s) if found, and compare them with vendored version.
$gitDir = isGitShim -gitPath $gitDir foreach ($git in (Get-Command -ErrorAction SilentlyContinue 'git')) {
$gitVersionUser = (readVersion -gitPath $gitDir) Write-Debug "GIT PATH: {$git.Path}"
Write-Debug "GIT USER: ${gitVersionUser}" $gitDir = Split-Path -Path $git.Path
$gitDir = isGitShim -gitPath $gitDir
$useGitVersion = compare_git_versions -userVersion $gitVersionUser -vendorVersion $gitVersionVendor $gitVersionUser = (readGitVersion -gitPath $gitDir)
Write-Debug "Using Git Version: ${useGitVersion}" Write-Debug "GIT USER: ${gitVersionUser}"
# Use user installed Git $useGitVersion = compare_git_versions -userVersion $gitVersionUser -vendorVersion $gitVersionVendor
if ($null -eq $gitPathUser) { Write-Debug "Using Git Version: ${useGitVersion}"
if ($gitDir -match '\\mingw32\\bin' -or $gitDir -match '\\mingw64\\bin') {
$gitPathUser = ($gitDir.subString(0,$gitDir.Length - 12)) # Use user installed Git
} else { if ($null -eq $gitPathUser) {
$gitPathUser = ($gitDir.subString(0,$gitDir.Length - 4)) if ($gitDir -match '\\mingw32\\bin' -or $gitDir -match '\\mingw64\\bin') {
} $gitPathUser = ($gitDir.subString(0,$gitDir.Length - 12))
} } else {
$gitPathUser = ($gitDir.subString(0,$gitDir.Length - 4))
if ($useGitVersion -eq $gitVersionUser) { }
Write-Debug "Using Git Dir: ${gitDir}" }
$ENV:GIT_INSTALL_ROOT = $gitPathUser
$ENV:GIT_INSTALL_TYPE = 'USER' if ($useGitVersion -eq $gitVersionUser) {
break Write-Debug "Using Git Dir: ${gitDir}"
} $ENV:GIT_INSTALL_ROOT = $gitPathUser
} $ENV:GIT_INSTALL_TYPE = 'USER'
break
# User vendored Git. }
if ($null -eq $ENV:GIT_INSTALL_ROOT -and $null -ne $gitVersionVendor) { }
$ENV:GIT_INSTALL_ROOT = "$ENV:CMDER_ROOT\vendor\git-for-windows"
$ENV:GIT_INSTALL_TYPE = 'VENDOR' # Use vendored Git if no user Git found or user Git is older than vendored Git
} if ($null -eq $ENV:GIT_INSTALL_ROOT -and $null -ne $gitVersionVendor) {
$ENV:GIT_INSTALL_ROOT = "$ENV:CMDER_ROOT\vendor\git-for-windows"
Write-Debug "GIT_INSTALL_ROOT: ${ENV:GIT_INSTALL_ROOT}" $ENV:GIT_INSTALL_TYPE = 'VENDOR'
Write-Debug "GIT_INSTALL_TYPE: ${ENV:GIT_INSTALL_TYPE}" }
if ($null -ne $ENV:GIT_INSTALL_ROOT) { Write-Debug "GIT_INSTALL_ROOT: ${ENV:GIT_INSTALL_ROOT}"
$env:Path = Configure-Git -gitRoot "$ENV:GIT_INSTALL_ROOT" -gitType $ENV:GIT_INSTALL_TYPE -gitPathUser $gitPathUser Write-Debug "GIT_INSTALL_TYPE: ${ENV:GIT_INSTALL_TYPE}"
}
if ($null -ne $ENV:GIT_INSTALL_ROOT) {
if (Get-Command -Name "vim" -ErrorAction SilentlyContinue) { $env:Path = Configure-Git -gitRoot "$ENV:GIT_INSTALL_ROOT" -gitType $ENV:GIT_INSTALL_TYPE -gitPathUser $gitPathUser
New-Alias -name "vi" -value vim }
}
# Create 'vi' alias for 'vim' if vim is available
if (Get-Module PSReadline -ErrorAction "SilentlyContinue") { if (Get-Command -Name "vim" -ErrorAction SilentlyContinue) {
Set-PSReadlineOption -ExtraPromptLineCount 1 New-Alias -name "vi" -value vim
}
# Add OSC 133;C support for Windows Terminal shell integration
# This marks the start of command output (emitted when Enter is pressed) # PSReadline configuration
if ($env:WT_SESSION) { if (Get-Module PSReadline -ErrorAction "SilentlyContinue") {
Set-PSReadLineKeyHandler -Key Enter -ScriptBlock { # Display an extra prompt line between the prompt and the command input
# Get the current command line Set-PSReadlineOption -ExtraPromptLineCount 1
$line = $null
$cursor = $null # Add OSC 133;C support for Windows Terminal shell integration
[Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line, [ref]$cursor) # This marks the start of command output (emitted when Enter is pressed)
if ($env:WT_SESSION) {
# Accept the line first Set-PSReadLineKeyHandler -Key Enter -ScriptBlock {
[Microsoft.PowerShell.PSConsoleReadLine]::AcceptLine() # Get the current command line
$line = $null
# Emit OSC 133;C sequence to mark start of command output $cursor = $null
# This is written directly to the console after the command is accepted [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line, [ref]$cursor)
[Console]::Write("$([char]27)]133;C$([char]7)")
} # Accept the line first
} [Microsoft.PowerShell.PSConsoleReadLine]::AcceptLine()
}
# Emit OSC 133;C sequence to mark start of command output
# Pre-assign default prompt hooks so the first run of cmder gets a working prompt. # This is written directly to the console after the command is accepted
$env:gitLoaded = $null [Console]::Write("$([char]0x1B)]133;C$([char]7)")
[ScriptBlock]$PrePrompt = {} }
[ScriptBlock]$PostPrompt = {} }
[ScriptBlock]$CmderPrompt = { }
# Check if we're currently running under Admin privileges.
$identity = [Security.Principal.WindowsIdentity]::GetCurrent() # Pre-assign default prompt hooks so the first run of Cmder gets a working prompt
$principal = [Security.Principal.WindowsPrincipal] $identity $env:gitLoaded = $null
$adminRole = [Security.Principal.WindowsBuiltInRole]::Administrator [ScriptBlock]$PrePrompt = {}
$color = "White" [ScriptBlock]$PostPrompt = {}
if ($principal.IsInRole($adminRole)) { $color = "Red" } [ScriptBlock]$CmderPrompt = {
$Host.UI.RawUI.ForegroundColor = "White" # Check if we're currently running under Admin privileges
Microsoft.PowerShell.Utility\Write-Host "PS " -NoNewline -ForegroundColor $color $identity = [Security.Principal.WindowsIdentity]::GetCurrent()
Microsoft.PowerShell.Utility\Write-Host $pwd.ProviderPath -NoNewLine -ForegroundColor Green $principal = [Security.Principal.WindowsPrincipal] $identity
checkGit($pwd.ProviderPath) $adminRole = [Security.Principal.WindowsBuiltInRole]::Administrator
Microsoft.PowerShell.Utility\Write-Host "`nλ" -NoNewLine -ForegroundColor "DarkGray" $color = "White"
} if ($principal.IsInRole($adminRole)) { $color = "Red" }
$Host.UI.RawUI.ForegroundColor = "White"
# Enhance Path Microsoft.PowerShell.Utility\Write-Host "PS " -NoNewline -ForegroundColor $color
$env:Path = "$Env:CMDER_ROOT\bin;$Env:CMDER_ROOT\vendor\bin;$env:Path;$Env:CMDER_ROOT" Microsoft.PowerShell.Utility\Write-Host $pwd.ProviderPath -NoNewLine -ForegroundColor Green
checkGit($pwd.ProviderPath)
# Drop *.ps1 files into "$ENV:CMDER_ROOT\config\profile.d" Microsoft.PowerShell.Utility\Write-Host "`nλ" -NoNewLine -ForegroundColor "DarkGray"
# to source them at startup. }
if (-not (Test-Path -PathType container "$ENV:CMDER_ROOT\config\profile.d")) {
New-Item -ItemType Directory -Path "$ENV:CMDER_ROOT\config\profile.d" # Enhance Path
} $env:Path = "$Env:CMDER_ROOT\bin;$Env:CMDER_ROOT\vendor\bin;$env:Path;$Env:CMDER_ROOT"
Push-Location $ENV:CMDER_ROOT\config\profile.d # Drop *.ps1 files into "$ENV:CMDER_ROOT\config\profile.d"
foreach ($x in Get-ChildItem *.psm1) { # to source them at startup.
Write-Verbose "Sourcing $x" if (-not (Test-Path -PathType container "$ENV:CMDER_ROOT\config\profile.d")) {
Import-Module $x New-Item -ItemType Directory -Path "$ENV:CMDER_ROOT\config\profile.d"
} }
foreach ($x in Get-ChildItem *.ps1) {
Write-Verbose "Sourcing $x" Push-Location $ENV:CMDER_ROOT\config\profile.d
. $x foreach ($x in Get-ChildItem *.psm1) {
} Write-Verbose "Sourcing $x"
Pop-Location Import-Module $x
}
# Drop *.ps1 files into "$ENV:CMDER_USER_CONFIG\config\profile.d" foreach ($x in Get-ChildItem *.ps1) {
# to source them at startup. Requires using cmder.exe /C [cmder_user_root_path] argument Write-Verbose "Sourcing $x"
if ($ENV:CMDER_USER_CONFIG -ne "" -and (Test-Path "$ENV:CMDER_USER_CONFIG\profile.d")) { . $x
Push-Location $ENV:CMDER_USER_CONFIG\profile.d }
foreach ($x in Get-ChildItem *.psm1) { Pop-Location
Write-Verbose "Sourcing $x"
Import-Module $x # Drop *.ps1 files into "$ENV:CMDER_USER_CONFIG\config\profile.d"
} # to source them at startup. Requires using cmder.exe /C [cmder_user_root_path] argument
foreach ($x in Get-ChildItem *.ps1) { if ($ENV:CMDER_USER_CONFIG -ne "" -and (Test-Path "$ENV:CMDER_USER_CONFIG\profile.d")) {
Write-Verbose "Sourcing $x" Push-Location $ENV:CMDER_USER_CONFIG\profile.d
. $x foreach ($x in Get-ChildItem *.psm1) {
} Write-Verbose "Sourcing $x"
Pop-Location Import-Module $x
} }
foreach ($x in Get-ChildItem *.ps1) {
# Renaming to "config\user_profile.ps1" to "user_profile.ps1" for consistency. Write-Verbose "Sourcing $x"
if (Test-Path "$env:CMDER_ROOT\config\user-profile.ps1") { . $x
Rename-Item "$env:CMDER_ROOT\config\user-profile.ps1" user_profile.ps1 }
} Pop-Location
}
$CmderUserProfilePath = Join-Path $env:CMDER_ROOT "config\user_profile.ps1"
if (Test-Path $CmderUserProfilePath) { # Renaming to "config\user_profile.ps1" to "user_profile.ps1" for consistency.
# Create this file and place your own command in there. if (Test-Path "$env:CMDER_ROOT\config\user-profile.ps1") {
. "$CmderUserProfilePath" # user_profile.ps1 is not a module DO NOT USE import-module Rename-Item "$env:CMDER_ROOT\config\user-profile.ps1" user_profile.ps1
} }
if ($ENV:CMDER_USER_CONFIG) { $CmderUserProfilePath = Join-Path $env:CMDER_ROOT "config\user_profile.ps1"
# Renaming to "$env:CMDER_USER_CONFIG\user-profile.ps1" to "user_profile.ps1" for consistency. if (Test-Path $CmderUserProfilePath) {
if (Test-Path "$env:CMDER_USER_CONFIG\user-profile.ps1") { # Create this file and place your own command in there.
Rename-Item "$env:CMDER_USER_CONFIG\user-profile.ps1" user_profile.ps1 . "$CmderUserProfilePath" # user_profile.ps1 is not a module DO NOT USE import-module
} }
$env:Path = "$Env:CMDER_USER_CONFIG\bin;$env:Path" if ($ENV:CMDER_USER_CONFIG) {
# Renaming to "$env:CMDER_USER_CONFIG\user-profile.ps1" to "user_profile.ps1" for consistency.
$CmderUserProfilePath = Join-Path $ENV:CMDER_USER_CONFIG "user_profile.ps1" if (Test-Path "$env:CMDER_USER_CONFIG\user-profile.ps1") {
if (Test-Path $CmderUserProfilePath) { Rename-Item "$env:CMDER_USER_CONFIG\user-profile.ps1" user_profile.ps1
. "$CmderUserProfilePath" # user_profile.ps1 is not a module DO NOT USE import-module }
}
} $env:Path = "$Env:CMDER_USER_CONFIG\bin;$env:Path"
if (-not (Test-Path $CmderUserProfilePath)) { $CmderUserProfilePath = Join-Path $ENV:CMDER_USER_CONFIG "user_profile.ps1"
$CmderUserProfilePath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($CmderUserProfilePath) if (Test-Path $CmderUserProfilePath) {
Write-Host -NoNewline "`r" . "$CmderUserProfilePath" # user_profile.ps1 is not a module DO NOT USE import-module
Write-Host -BackgroundColor Green -ForegroundColor Black "First Run: Creating user startup file: $CmderUserProfilePath" }
Copy-Item "$env:CMDER_ROOT\vendor\user_profile.ps1.default" -Destination $CmderUserProfilePath }
}
if (-not (Test-Path $CmderUserProfilePath)) {
# $CmderUserProfilePath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($CmderUserProfilePath)
# Prompt Section Write-Host -NoNewline "`r"
# Users should modify their user_profile.ps1 as it will be safe from updates. Write-Host -BackgroundColor Green -ForegroundColor Black "First Run: Creating user startup file: $CmderUserProfilePath"
# Copy-Item "$env:CMDER_ROOT\vendor\user_profile.ps1.default" -Destination $CmderUserProfilePath
}
# Only set the prompt if it is currently set to the default
# This allows users to configure the prompt in their user_profile.ps1 or config\profile.d\*.ps1 #
if ( $(Get-Command prompt).Definition -match 'PS \$\(\$executionContext.SessionState.Path.CurrentLocation\)\$\(' -and ` # Prompt Section
$(Get-Command prompt).Definition -match '\(\$nestedPromptLevel \+ 1\)\) ";') { # Users should modify their user_profile.ps1 as it will be safe from updates.
#
<#
This scriptblock runs every time the prompt is returned. # Only set the prompt if it is currently set to the default
Explicitly use functions from MS namespace to protect from being overridden in the user session. # This allows users to configure the prompt in their user_profile.ps1 or config\profile.d\*.ps1
Custom prompt functions are loaded in as constants to get the same behaviour if ( $(Get-Command prompt).Definition -match 'PS \$\(\$executionContext.SessionState.Path.CurrentLocation\)\$\(' -and `
#> $(Get-Command prompt).Definition -match '\(\$nestedPromptLevel \+ 1\)\) ";') {
[ScriptBlock]$Prompt = {
$lastSUCCESS = $? <#
$realLastExitCode = $LastExitCode This scriptblock runs every time the prompt is returned.
Explicitly use functions from MS namespace to protect from being overridden in the user session.
# Emit OSC 9;9 sequence for Windows Terminal directory tracking Custom prompt functions are loaded in as constants to get the same behaviour
# This enables "Duplicate Tab" and "Split Pane" to preserve the working directory #>
# Only active in Windows Terminal ($env:WT_SESSION) or ConEmu ($env:ConEmuPID) [ScriptBlock]$Prompt = {
$loc = $executionContext.SessionState.Path.CurrentLocation $lastSUCCESS = $?
if (($env:WT_SESSION -or $env:ConEmuPID) -and $loc.Provider.Name -eq "FileSystem") { $realLastExitCode = $LastExitCode
Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]27)]9;9;`"$($loc.ProviderPath)`"$([char]27)\"
} # Emit OSC 9;9 sequence for Windows Terminal directory tracking
# This enables "Duplicate Tab" and "Split Pane" to preserve the working directory
# Emit OSC 133;A sequence for Windows Terminal shell integration # Only active in Windows Terminal ($env:WT_SESSION) or ConEmu ($env:ConEmuPID)
# This marks the start of the prompt $loc = $executionContext.SessionState.Path.CurrentLocation
# Enables features like command navigation, selection, and visual separators if (($env:WT_SESSION -or $env:ConEmuPID) -and $loc.Provider.Name -eq "FileSystem") {
# Only active in Windows Terminal ($env:WT_SESSION) Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]0x1B)]9;9;`"$($loc.ProviderPath)`"$([char]0x1B)\"
if ($env:WT_SESSION) { }
Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]27)]133;A$([char]7)"
} # Emit OSC 133;A sequence for Windows Terminal shell integration
# This marks the start of the prompt
$host.UI.RawUI.WindowTitle = Microsoft.PowerShell.Management\Split-Path $pwd.ProviderPath -Leaf # Enables features like command navigation, selection, and visual separators
Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]0x200B)`r$([char]0x1B)[K" # Only active in Windows Terminal ($env:WT_SESSION)
if ($lastSUCCESS -or ($LastExitCode -ne 0)) { if ($env:WT_SESSION) {
Microsoft.PowerShell.Utility\Write-Host Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]0x1B)]133;A$([char]7)"
} }
PrePrompt | Microsoft.PowerShell.Utility\Write-Host -NoNewline
CmderPrompt $host.UI.RawUI.WindowTitle = Microsoft.PowerShell.Management\Split-Path $pwd.ProviderPath -Leaf
PostPrompt | Microsoft.PowerShell.Utility\Write-Host -NoNewline Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]0x200B)`r$([char]0x1B)[K"
if ($lastSUCCESS -or ($LastExitCode -ne 0)) {
# Emit OSC 133;B sequence for Windows Terminal shell integration Microsoft.PowerShell.Utility\Write-Host
# This marks the start of command input (after prompt, before user types) }
if ($env:WT_SESSION) { PrePrompt | Microsoft.PowerShell.Utility\Write-Host -NoNewline
Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]27)]133;B$([char]7)" CmderPrompt
} PostPrompt | Microsoft.PowerShell.Utility\Write-Host -NoNewline
$global:LastExitCode = $realLastExitCode # Emit OSC 133;B sequence for Windows Terminal shell integration
return " " # This marks the start of command input (after prompt, before user types)
} if ($env:WT_SESSION) {
Microsoft.PowerShell.Utility\Write-Host -NoNewline "$([char]0x1B)]133;B$([char]7)"
# Once Created these code blocks cannot be overwritten }
# if (-not $(Get-Command PrePrompt).Options -match 'Constant') {Set-Item -Path function:\PrePrompt -Value $PrePrompt -Options Constant}
# if (-not $(Get-Command CmderPrompt).Options -match 'Constant') {Set-Item -Path function:\CmderPrompt -Value $CmderPrompt -Options Constant} $global:LastExitCode = $realLastExitCode
# if (-not $(Get-Command PostPrompt).Options -match 'Constant') {Set-Item -Path function:\PostPrompt -Value $PostPrompt -Options Constant} return " "
}
Set-Item -Path function:\PrePrompt -Value $PrePrompt -Options Constant
Set-Item -Path function:\CmderPrompt -Value $CmderPrompt -Options Constant # Once Created these code blocks cannot be overwritten
Set-Item -Path function:\PostPrompt -Value $PostPrompt -Options Constant # if (-not $(Get-Command PrePrompt).Options -match 'Constant') {Set-Item -Path function:\PrePrompt -Value $PrePrompt -Options Constant}
# if (-not $(Get-Command CmderPrompt).Options -match 'Constant') {Set-Item -Path function:\CmderPrompt -Value $CmderPrompt -Options Constant}
# Functions can be made constant only at creation time # if (-not $(Get-Command PostPrompt).Options -match 'Constant') {Set-Item -Path function:\PostPrompt -Value $PostPrompt -Options Constant}
# ReadOnly at least requires `-force` to be overwritten
# if (!$(Get-Command Prompt).Options -match 'ReadOnly') {Set-Item -Path function:\prompt -Value $Prompt -Options ReadOnly} Set-Item -Path function:\PrePrompt -Value $PrePrompt -Options Constant
Set-Item -Path function:\prompt -Value $Prompt -Options ReadOnly Set-Item -Path function:\CmderPrompt -Value $CmderPrompt -Options Constant
} Set-Item -Path function:\PostPrompt -Value $PostPrompt -Options Constant
$CMDER_INIT_END = Get-Date # Functions can be made constant only at creation time
# ReadOnly at least requires `-force` to be overwritten
$ElapsedTime = New-TimeSpan -Start $CMDER_INIT_START -End $CMDER_INIT_END # if (!$(Get-Command Prompt).Options -match 'ReadOnly') {Set-Item -Path function:\prompt -Value $Prompt -Options ReadOnly}
Set-Item -Path function:\prompt -Value $Prompt -Options ReadOnly
Write-Verbose "Elapsed Time: $($ElapsedTime.TotalSeconds) seconds total" }
$CMDER_INIT_END = Get-Date
$ElapsedTime = New-TimeSpan -Start $CMDER_INIT_START -End $CMDER_INIT_END
Write-Verbose "Elapsed Time: $($ElapsedTime.TotalSeconds) seconds total"

View File

@@ -1,179 +1,179 @@
function readVersion($gitPath) { function readGitVersion($gitPath) {
$gitExecutable = "${gitPath}\git.exe" $gitExecutable = "${gitPath}\git.exe"
if (-not (Test-Path "$gitExecutable")) { if (-not (Test-Path "$gitExecutable")) {
return $null return $null
} }
$gitVersion = (cmd /c "${gitExecutable}" --version) $gitVersion = (cmd /c "${gitExecutable}" --version)
if ($gitVersion -match 'git version') { if ($gitVersion -match 'git version') {
($trash1, $trash2, $gitVersion) = $gitVersion.split(' ', 3) ($trash1, $trash2, $gitVersion) = $gitVersion.split(' ', 3)
} else { } else {
pause pause
return $null return $null
} }
return $gitVersion.toString() return $gitVersion.toString()
} }
function isGitShim($gitPath) { function isGitShim($gitPath) {
# check if there is a shim file - if yes, read the actual executable path # Check if there is a shim file - if yes, read the actual executable path
# See: github.com/ScoopInstaller/Shim # See: github.com/ScoopInstaller/Shim
if (Test-Path "${gitPath}\git.shim") { if (Test-Path "${gitPath}\git.shim") {
$shim = (get-content "${gitPath}\git.shim") $shim = (get-content "${gitPath}\git.shim")
($trash, $gitPath) = $shim.replace(' ', '').split('=') ($trash, $gitPath) = $shim.replace(' ', '').split('=')
$gitPath = $gitPath.replace('\git.exe', '') $gitPath = $gitPath.replace('\git.exe', '')
} }
return $gitPath.toString() return $gitPath.toString()
} }
function compareVersions($userVersion, $vendorVersion) { function compareVersions($userVersion, $vendorVersion) {
if ($null -ne $userVersion) { if ($null -ne $userVersion) {
($userMajor, $userMinor, $userPatch, $userBuild) = $userVersion.split('.', 4) ($userMajor, $userMinor, $userPatch, $userBuild) = $userVersion.split('.', 4)
} else { } else {
return -1 return -1
} }
if ($null -ne $vendorVersion) { if ($null -ne $vendorVersion) {
($vendorMajor, $vendorMinor, $vendorPatch, $vendorBuild) = $vendorVersion.split('.', 4) ($vendorMajor, $vendorMinor, $vendorPatch, $vendorBuild) = $vendorVersion.split('.', 4)
} else { } else {
return 1 return 1
} }
if (($userMajor -eq $vendorMajor) -and ($userMinor -eq $vendorMinor) -and ($userPatch -eq $vendorPatch) -and ($userBuild -eq $vendorBuild)) { if (($userMajor -eq $vendorMajor) -and ($userMinor -eq $vendorMinor) -and ($userPatch -eq $vendorPatch) -and ($userBuild -eq $vendorBuild)) {
return 1 return 1
} }
if ($userMajor -gt $vendorMajor) { return 1 } if ($userMajor -gt $vendorMajor) { return 1 }
if ($userMajor -lt $vendorMajor) { return -1 } if ($userMajor -lt $vendorMajor) { return -1 }
if ($userMinor -gt $vendorMinor) { return 1 } if ($userMinor -gt $vendorMinor) { return 1 }
if ($userMinor -lt $vendorMinor) { return -1 } if ($userMinor -lt $vendorMinor) { return -1 }
if ($userPatch -gt $vendorPatch) { return 1 } if ($userPatch -gt $vendorPatch) { return 1 }
if ($userPatch -lt $vendorPatch) { return -1 } if ($userPatch -lt $vendorPatch) { return -1 }
if ($userBuild -gt $vendorBuild) { return 1 } if ($userBuild -gt $vendorBuild) { return 1 }
if ($userBuild -lt $vendorBuild) { return -1 } if ($userBuild -lt $vendorBuild) { return -1 }
return 0 return 0
} }
function compare_git_versions($userVersion, $vendorVersion) { function compare_git_versions($userVersion, $vendorVersion) {
$result = compareVersions -userVersion $userVersion -vendorVersion $vendorVersion $result = compareVersions -userVersion $userVersion -vendorVersion $vendorVersion
Write-Debug "Compare Versions Result: ${result}" Write-Debug "Compare Versions Result: ${result}"
if ($result -ge 0) { if ($result -ge 0) {
return $userVersion return $userVersion
} }
else { else {
return $vendorVersion return $vendorVersion
} }
} }
function Configure-Git($gitRoot, $gitType, $gitPathUser) { function Configure-Git($gitRoot, $gitType, $gitPathUser) {
# Proposed Behavior # Proposed Behavior
# Modify the path if we are using VENDORED Git, do nothing if using USER Git. # Modify the path if we are using VENDORED Git, do nothing if using USER Git.
# If User Git is installed but is older, match its path config adding paths # If User Git is installed but is older, match its path config adding paths
# in the same path positions allowing a user to configure Cmder Git path # in the same path positions allowing a user to configure Cmder Git path
# using locally installed Git Path Config. # using locally installed Git Path Config.
if ($gitType -eq 'VENDOR') { if ($gitType -eq 'VENDOR') {
# If User Git is installed replace its path config with Newer Vendored Git Path # If User Git is installed replace its path config with Newer Vendored Git Path
if (($null -ne $gitPathUser) -and ($gitPathUser -ne '')) { if (($null -ne $gitPathUser) -and ($gitPathUser -ne '')) {
Write-Verbose "Cmder 'profile.ps1': Replacing older user Git path '$gitPathUser' with newer vendored Git path '$gitRoot' in the system path..." Write-Verbose "Cmder 'profile.ps1': Replacing older user Git path '$gitPathUser' with newer vendored Git path '$gitRoot' in the system path..."
$newPath = ($env:path -ireplace [regex]::Escape($gitPathUser), $gitRoot) $newPath = ($env:path -ireplace [regex]::Escape($gitPathUser), $gitRoot)
} }
else { else {
if (-not ($env:Path -match [regex]::Escape("$gitRoot\cmd"))) { if (-not ($env:Path -match [regex]::Escape("$gitRoot\cmd"))) {
Write-Debug "Adding $gitRoot\cmd to the path" Write-Debug "Adding $gitRoot\cmd to the path"
$newPath = $($gitRoot + "\cmd" + ";" + $env:Path) $newPath = $($gitRoot + "\cmd" + ";" + $env:Path)
} }
# Add "$gitRoot\mingw[32|64]\bin" to the path if exists and not done already # Add "$gitRoot\mingw[32|64]\bin" to the path if exists and not done already
if ((Test-Path "$gitRoot\mingw32\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\mingw32\bin"))) { if ((Test-Path "$gitRoot\mingw32\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\mingw32\bin"))) {
Write-Debug "Adding $gitRoot\mingw32\bin to the path" Write-Debug "Adding $gitRoot\mingw32\bin to the path"
$newPath = "$newPath;$gitRoot\mingw32\bin" $newPath = "$newPath;$gitRoot\mingw32\bin"
} }
elseif ((Test-Path "$gitRoot\mingw64\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\mingw64\bin"))) { elseif ((Test-Path "$gitRoot\mingw64\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\mingw64\bin"))) {
Write-Debug "Adding $gitRoot\mingw64\bin to the path" Write-Debug "Adding $gitRoot\mingw64\bin to the path"
$newPath = "$newPath;$gitRoot\mingw64\bin" $newPath = "$newPath;$gitRoot\mingw64\bin"
} }
# Add "$gitRoot\usr\bin" to the path if exists and not done already # Add "$gitRoot\usr\bin" to the path if exists and not done already
if ((Test-Path "$gitRoot\usr\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\usr\bin"))) { if ((Test-Path "$gitRoot\usr\bin") -and -not ($env:path -match [regex]::Escape("$gitRoot\usr\bin"))) {
Write-Debug "Adding $gitRoot\usr\bin to the path" Write-Debug "Adding $gitRoot\usr\bin to the path"
$newPath = "$newPath;$gitRoot\usr\bin" $newPath = "$newPath;$gitRoot\usr\bin"
} }
} }
return $newPath return $newPath
} }
return $env:path return $env:path
} }
function Import-Git() { function Import-Git() {
$GitModule = Get-Module -Name Posh-Git -ListAvailable $GitModule = Get-Module -Name Posh-Git -ListAvailable
if ($GitModule | Select-Object version | Where-Object version -le ([version]"0.6.1.20160330")) { if ($GitModule | Select-Object version | Where-Object version -le ([version]"0.6.1.20160330")) {
Import-Module Posh-Git > $null Import-Module Posh-Git > $null
} }
if ($GitModule | Select-Object version | Where-Object version -ge ([version]"1.0.0")) { if ($GitModule | Select-Object version | Where-Object version -ge ([version]"1.0.0")) {
Import-Module Posh-Git > $null Import-Module Posh-Git > $null
$GitPromptSettings.AnsiConsole = $false $GitPromptSettings.AnsiConsole = $false
} }
if (-not $GitModule) { if (-not $GitModule) {
Write-Host -NoNewline "`r`n" Write-Host -NoNewline "`r`n"
Write-Warning "Missing git support, install posh-git with 'Install-Module posh-git' and restart Cmder." Write-Warning "Missing git support, install posh-git with 'Install-Module posh-git' and restart Cmder."
Write-Host -NoNewline "`r$([char]0x1B)[A" Write-Host -NoNewline "`r$([char]0x1B)[A"
return $false return $false
} }
# Make sure we only run once by always returning true # Make sure we only run once by always returning true
return $true return $true
} }
function checkGit($Path) { function checkGit($Path) {
if (-not (Get-Command git -ErrorAction SilentlyContinue)) { if (-not (Get-Command git -ErrorAction SilentlyContinue)) {
return return
} }
if (-not (Test-Path -Path (Join-Path $Path '.git'))) { if (-not (Test-Path -Path (Join-Path $Path '.git'))) {
$SplitPath = Split-Path $path $SplitPath = Split-Path $path
if ($SplitPath) { checkGit($SplitPath) } if ($SplitPath) { checkGit($SplitPath) }
return return
} }
if (getGitStatusSetting -eq $true) { if (getGitStatusSetting -eq $true) {
if ($null -eq $env:gitLoaded) { if ($null -eq $env:gitLoaded) {
$env:gitLoaded = Import-Git $env:gitLoaded = Import-Git
} }
if ($env:gitLoaded -eq $true) { if ($env:gitLoaded -eq $true) {
Write-VcsStatus Write-VcsStatus
} }
} }
else { else {
$headContent = Get-Content (Join-Path $Path '.git/HEAD') $headContent = Get-Content (Join-Path $Path '.git/HEAD')
if ($headContent -like "ref: refs/heads/*") { if ($headContent -like "ref: refs/heads/*") {
$branchName = $headContent.Substring(16) $branchName = $headContent.Substring(16)
} }
else { else {
$branchName = "HEAD detached at $($headContent.Substring(0, 7))" $branchName = "HEAD detached at $($headContent.Substring(0, 7))"
} }
Write-Host " [$branchName]" -NoNewline -ForegroundColor White Write-Host " [$branchName]" -NoNewline -ForegroundColor White
} }
} }
function getGitStatusSetting() { function getGitStatusSetting() {
$gitStatus = (git --no-pager config -l) | Out-String $gitStatus = (git --no-pager config -l) | Out-String
foreach ($line in $($gitStatus -split "`r`n")) { foreach ($line in $($gitStatus -split "`r`n")) {
if (($line -match 'cmder.status=false') -or ($line -match 'cmder.psstatus=false')) { if (($line -match 'cmder.status=false') -or ($line -match 'cmder.psstatus=false')) {
return $false return $false
} }
} }
return $true return $true
} }