mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-11-09 20:44:03 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

feat: adjust var names for consistency

Browse source 
BREAKING CHANGE: adjusts the way some segment work for templates.

Mapping the var names as following will resolve the issue.
- session/title/general purpose
    - .Host -> .HostName
    - .User -> .UserName
- az
    - .UserName -> .Name
- kubectl
    - .UserName -> .User
This commit is contained in:
Jan De Dobbeleer 2022-01-17 13:16:04 +01:00 committed by Jan De Dobbeleer
parent 115759f4d3
commit e6d4413ae7
42 changed files with 77 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docs/config-title.md
View file

@ -37,8 +37,8 @@ offers a few standard properties to work with.
- `.PWD`: `string` - the current working directory
- `.Folder`: `string` - the current working folder
- `.Shell`: `string` - the current shell name
- `.User`: `string` - the current user name
- `.Host`: `string` - the host name
- `.UserName`: `string` - the current user name
- `.HostName`: `string` - the host name
- `.Env.VarName`: `string` - Any environment variable where `VarName` is the environment variable name
A `boolean` can be used for conditional display purposes, a `string` can be displayed.
@ -54,7 +54,7 @@ the current working directory is `/usr/home/omp` and the shell is `zsh`.
// when root == true: omp :: root :: zsh
"console_title_template": "{{.Folder}}", // outputs: omp
"console_title_template": "{{.Shell}} in {{.PWD}}", // outputs: zsh in /usr/home/omp
"console_title_template": "{{.User}}@{{.Host}} {{.Shell}} in {{.PWD}}", // outputs: MyUser@MyMachine zsh in /usr/home/omp
"console_title_template": "{{.UserName}}@{{.HostName}} {{.Shell}} in {{.PWD}}", // outputs: MyUser@MyMachine zsh in /usr/home/omp
"console_title_template": "{{.Env.USERDOMAIN}} {{.Shell}} in {{.PWD}}", // outputs: MyCompany zsh in /usr/home/omp
}
```

4
docs/docs/config-transient.mdx
View file

@ -55,8 +55,8 @@ properties below - defaults to `{{ .Shell }}> `
- `.Path`: `string` - the current working directory
- `.Folder`: `string` - the current working folder
- `.Shell`: `string` - the current shell name
- `.User`: `string` - the current user name
- `.Host`: `string` - the host name
- `.UserName`: `string` - the current user name
- `.HostName`: `string` - the host name
- `.Env.VarName`: `string` - Any environment variable where `VarName` is the environment variable name
## Enable the feature

2
docs/docs/segment-kubectl.md
View file

@ -36,7 +36,7 @@ performance - defaults to `false`
- `.Context`: `string` - the current kubectl context
- `.Namespace`: `string` - the current kubectl context namespace
- `.UserName`: `string` - the current kubectl context user
- `.User`: `string` - the current kubectl context user
- `.Cluster`: `string` - the current kubectl context cluster
## Tips

2
docs/docs/segment-session.md
View file

@ -32,7 +32,7 @@ properties below.
## Template Properties
- `.UserName`: `string` - the current user's name
- `.ComputerName`: `string` - the current computer's name
- `.HostName`: `string` - the current computer's name
- `.SSHSession`: `boolean` - active SSH session or not
- `.Root`: `boolean` - are you a root/admin user or not

4
docs/docs/segment-text.md
View file

@ -46,8 +46,8 @@ with [sprig][sprig] utilizing the properties below.
- `.Path`: `string` - the current working directory
- `.Folder`: `string` - the current working folder
- `.Shell`: `string` - the current shell name
- `.User`: `string` - the current user name
- `.Host`: `string` - the host name
- `.UserName`: `string` - the current user name
- `.HostName`: `string` - the host name
- `.Env.VarName`: `string` - Any environment variable where `VarName` is the environment variable name
[coloring]: /docs/config-colors

6
src/console_title_test.go
View file

@ -39,7 +39,7 @@ func TestGetConsoleTitle(t *testing.T) {
},
{
Style: Template,
Template: "{{.User}}@{{.Host}}{{if .Root}} :: Admin{{end}} :: {{.Shell}}",
Template: "{{.UserName}}@{{.HostName}}{{if .Root}} :: Admin{{end}} :: {{.Shell}}",
Root: true,
User: "MyUser",
PathSeperator: "\\",
@ -88,7 +88,7 @@ func TestGetConsoleTitleIfGethostnameReturnsError(t *testing.T) {
}{
{
Style: Template,
Template: "Not using Host only {{.User}} and {{.Shell}}",
Template: "Not using Host only {{.UserName}} and {{.Shell}}",
User: "MyUser",
PathSeperator: "\\",
ShellName: "PowerShell",
@ -96,7 +96,7 @@ func TestGetConsoleTitleIfGethostnameReturnsError(t *testing.T) {
},
{
Style: Template,
Template: "{{.User}}@{{.Host}} :: {{.Shell}}",
Template: "{{.UserName}}@{{.HostName}} :: {{.Shell}}",
User: "MyUser",
PathSeperator: "\\",
ShellName: "PowerShell",

4
src/segment_az.go
View file

@ -21,7 +21,7 @@ type AzureConfig struct {
type AzureSubscription struct {
ID string `json:"id"`
UserName string `json:"name"`
Name string `json:"name"`
State string `json:"state"`
User *AzureUser `json:"user"`
IsDefault bool `json:"isDefault"`
@ -153,7 +153,7 @@ func (a *az) getAzureRmContext() bool {
a.EnvironmentName = defaultContext.Environment.Name
a.TenantID = defaultContext.Tenant.ID
a.ID = defaultContext.Subscription.ID
a.UserName = defaultContext.Subscription.Name
a.Name = defaultContext.Subscription.Name
a.State = defaultContext.Subscription.State
a.User = &AzureUser{
Name: defaultContext.Subscription.ExtendedProperties.Account,

14
src/segment_deprecated.go
View file

@ -284,14 +284,14 @@ func (s *session) getDefaultUser() string {
func (s *session) legacyEnabled() bool {
if s.props.getBool(DisplayUser, true) {
s.UserName = s.getUserName()
s.userName = s.getUserName()
}
if s.props.getBool(DisplayHost, true) {
s.ComputerName = s.getComputerName()
s.hostName = s.getComputerName()
}
s.DefaultUserName = s.getDefaultUser()
showDefaultUser := s.props.getBool(DisplayDefault, true)
if !showDefaultUser && s.DefaultUserName == s.UserName {
if !showDefaultUser && s.DefaultUserName == s.userName {
return false
}
return true
@ -310,15 +310,15 @@ func (s *session) getFormattedText() string {
userColor := s.props.getColor(UserColor, defaulColor)
hostColor := s.props.getColor(HostColor, defaulColor)
if len(userColor) > 0 && len(hostColor) > 0 {
return fmt.Sprintf("%s<%s>%s</>%s<%s>%s</>", sshIcon, userColor, s.UserName, separator, hostColor, s.ComputerName)
return fmt.Sprintf("%s<%s>%s</>%s<%s>%s</>", sshIcon, userColor, s.userName, separator, hostColor, s.hostName)
}
if len(userColor) > 0 {
return fmt.Sprintf("%s<%s>%s</>%s%s", sshIcon, userColor, s.UserName, separator, s.ComputerName)
return fmt.Sprintf("%s<%s>%s</>%s%s", sshIcon, userColor, s.userName, separator, s.hostName)
}
if len(hostColor) > 0 {
return fmt.Sprintf("%s%s%s<%s>%s</>", sshIcon, s.UserName, separator, hostColor, s.ComputerName)
return fmt.Sprintf("%s%s%s<%s>%s</>", sshIcon, s.userName, separator, hostColor, s.hostName)
}
return fmt.Sprintf("%s%s%s%s", sshIcon, s.UserName, separator, s.ComputerName)
return fmt.Sprintf("%s%s%s%s", sshIcon, s.userName, separator, s.hostName)
}
// Language

4
src/segment_kubectl.go
View file

@ -26,7 +26,7 @@ type KubeConfig struct {
type KubeContext struct {
Cluster string `yaml:"cluster"`
UserName string `yaml:"user"`
User string `yaml:"user"`
Namespace string `yaml:"namespace"`
}
@ -139,6 +139,6 @@ func (k *kubectl) setError(message string) {
k.Context = message
}
k.Namespace = message
k.UserName = message
k.User = message
k.Cluster = message
}

2
src/segment_kubectl_test.go
View file

@ -9,7 +9,7 @@ import (
"github.com/stretchr/testify/assert"
)
const testKubectlAllInfoTemplate = "{{.Context}} :: {{.Namespace}} :: {{.UserName}} :: {{.Cluster}}"
const testKubectlAllInfoTemplate = "{{.Context}} :: {{.Namespace}} :: {{.User}} :: {{.Cluster}}"
func TestKubectlSegment(t *testing.T) {
standardTemplate := "{{.Context}}{{if .Namespace}} :: {{.Namespace}}{{end}}"

8
src/segment_session.go
View file

@ -7,10 +7,9 @@ type session struct {
env Environment
text string
UserName string
ComputerName string
userName string
hostName string
SSHSession bool
Root bool
// Deprecated
DefaultUserName string
@ -22,9 +21,6 @@ func (s *session) enabled() bool {
if segmentTemplate == "" {
return s.legacyEnabled()
}
s.UserName = s.getUserName()
s.ComputerName = s.getComputerName()
s.Root = s.env.isRunningAsRoot()
template := &textTemplate{
Template: segmentTemplate,
Context: s,

8
src/segment_session_test.go
View file

@ -23,7 +23,7 @@ func TestSessionSegmentTemplate(t *testing.T) {
ExpectedString: "john@company-laptop",
ComputerName: "company-laptop",
UserName: "john",
Template: "{{.UserName}}@{{.ComputerName}}",
Template: "{{.UserName}}@{{.HostName}}",
ExpectedEnabled: true,
},
{
@ -39,7 +39,7 @@ func TestSessionSegmentTemplate(t *testing.T) {
UserName: "john",
SSHSession: true,
ComputerName: "remote",
Template: "{{.UserName}}{{if .SSHSession}} on {{.ComputerName}}{{end}}",
Template: "{{.UserName}}{{if .SSHSession}} on {{.HostName}}{{end}}",
ExpectedEnabled: true,
},
{
@ -48,7 +48,7 @@ func TestSessionSegmentTemplate(t *testing.T) {
UserName: "john",
SSHSession: false,
ComputerName: "remote",
Template: "{{.UserName}}{{if .SSHSession}} on {{.ComputerName}}{{end}}",
Template: "{{.UserName}}{{if .SSHSession}} on {{.HostName}}{{end}}",
ExpectedEnabled: true,
},
{
@ -58,7 +58,7 @@ func TestSessionSegmentTemplate(t *testing.T) {
SSHSession: true,
ComputerName: "remote",
Root: true,
Template: "{{if .Root}}super {{end}}{{.UserName}}{{if .SSHSession}} on {{.ComputerName}}{{end}}",
Template: "{{if .Root}}super {{end}}{{.UserName}}{{if .SSHSession}} on {{.HostName}}{{end}}",
ExpectedEnabled: true,
},
{

2
src/segment_text_test.go
View file

@ -17,7 +17,7 @@ func TestTextSegment(t *testing.T) {
{Case: "template text with env var", ExpectedString: "hello world", Text: "{{ .Env.HELLO }} world"},
{Case: "template text with shell name", ExpectedString: "hello world from terminal", Text: "{{ .Env.HELLO }} world from {{ .Shell }}"},
{Case: "template text with folder", ExpectedString: "hello world in posh", Text: "{{ .Env.HELLO }} world in {{ .Folder }}"},
{Case: "template text with user", ExpectedString: "hello Posh", Text: "{{ .Env.HELLO }} {{ .User }}"},
{Case: "template text with user", ExpectedString: "hello Posh", Text: "{{ .Env.HELLO }} {{ .UserName }}"},
{Case: "empty text", Text: "", ExpectedDisabled: true},
{Case: "empty template result", Text: "{{ .Env.WORLD }}", ExpectedDisabled: true},
}

10
src/template.go
View file

@ -30,8 +30,8 @@ type Context struct {
PWD string
Folder string
Shell string
User string
Host string
UserName string
HostName string
Code int
Env map[string]string
OS string
@ -51,9 +51,9 @@ func (c *Context) init(t *textTemplate) {
c.PWD = pwd
c.Folder = base(c.PWD, t.Env)
c.Shell = t.Env.getShellName()
c.User = t.Env.getCurrentUser()
c.UserName = t.Env.getCurrentUser()
if host, err := t.Env.getHostName(); err == nil {
c.Host = host
c.HostName = host
}
c.Code = t.Env.lastErrorCode()
c.Env = t.Env.environ()
@ -104,7 +104,7 @@ func (t *textTemplate) cleanTemplate() {
*knownVariables = append(*knownVariables, splitted[0])
return splitted[0], true
}
knownVariables := []string{"Root", "PWD", "Folder", "Shell", "User", "Host", "Env", "Data", "Code", "OS"}
knownVariables := []string{"Root", "PWD", "Folder", "Shell", "UserName", "HostName", "Env", "Data", "Code", "OS"}
matches := findAllNamedRegexMatch(`(?: |{)(?P<var>(\.[a-zA-Z_][a-zA-Z0-9]*)+)`, t.Template)
for _, match := range matches {
if variable, OK := unknownVariable(match["var"], &knownVariables); OK {

2
themes/agnoster.omp.json
View file

@ -19,7 +19,7 @@
"foreground": "#100e23",
"background": "#ffffff",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/agnosterplus.omp.json
View file

@ -28,7 +28,7 @@
"foreground": "#100e23",
"background": "#ffffff",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/aliens.omp.json
View file

@ -13,7 +13,7 @@
"leading_diamond": "\uE0B6",
"trailing_diamond": "\uE0B0",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/atomicBit.omp.json
View file

@ -13,7 +13,7 @@
"properties": {
"prefix": "╭─[",
"postfix": "]─",
"template": "<#ffff55>{{ .UserName }}</><#ff5555>@</><#55ff55>{{ .ComputerName }}</>"
"template": "<#ffff55>{{ .UserName }}</><#ff5555>@</><#55ff55>{{ .HostName }}</>"
}
},
{

4
themes/blue-owl.omp.json
View file

@ -4,7 +4,7 @@
"osc99": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏚\" }} @ {{.Host}}",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏚\" }} @ {{.HostName}}",
"blocks": [
{
"type": "prompt",
@ -101,7 +101,7 @@
"properties": {
"postfix": "",
"prefix": " ",
"template": "{{ .UserName }}<transparent> / </>{{ .ComputerName }}"
"template": "{{ .UserName }}<transparent> / </>{{ .HostName }}"
}
},
{

2
themes/blueish.omp.json
View file

@ -24,7 +24,7 @@
"background": "#546E7A",
"powerline_symbol": "\uE0B0",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/capr4n.omp.json
View file

@ -3,7 +3,7 @@
"final_space": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.User}} ➔ 📁{{.Folder}}",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.UserName}} ➔ 📁{{.Folder}}",
"blocks": [
{
"type": "rprompt",

2
themes/cinnamon.omp.json
View file

@ -12,7 +12,7 @@
"background": "#07585c",
"leading_diamond": "\uE0B6",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/fish.omp.json
View file

@ -24,7 +24,7 @@
"style": "plain",
"foreground": "#ffffff",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/gmay.omp.json
View file

@ -18,7 +18,7 @@
"foreground": "#ffffff",
"background": "#3A86FF",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/grandpa-style.omp.json
View file

@ -4,7 +4,7 @@
"osc99": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏚\" }} @ {{.Host}}",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏚\" }} @ {{.HostName}}",
"blocks": [
{
"type": "prompt",

2
themes/honukai.omp.json
View file

@ -11,7 +11,7 @@
"foreground": "#FFFFFF",
"properties": {
"prefix": "<#0377C8># </>",
"template": "<#0377C8>{{ .UserName }}</> <#ffffff>in</> <#4A9207>{{ .ComputerName }}</>"
"template": "<#0377C8>{{ .UserName }}</> <#ffffff>in</> <#4A9207>{{ .HostName }}</>"
}
},
{

2
themes/jblab_2021.omp.json
View file

@ -4,7 +4,7 @@
"osc99": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏠\"}} @ {{.Host}}",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.Folder | replace \"~\" \"🏠\"}} @ {{.HostName}}",
"blocks": [
{
"type": "prompt",

2
themes/jonnychipz.omp.json
View file

@ -29,7 +29,7 @@
"leading_diamond": "\uE0B6",
"trailing_diamond": "\uE0B0",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

4
themes/mojada.omp.json
View file

@ -33,7 +33,7 @@
"properties": {
"prefix": "",
"display_host": true,
"template": "{{ .UserName }}<#000000>@</><#e06c75>{{ .ComputerName }}</>"
"template": "{{ .UserName }}<#000000>@</><#e06c75>{{ .HostName }}</>"
}
},
{
@ -150,5 +150,5 @@
"final_space": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{.User}}@{{.Host}} : {{.Folder}}"
"console_title_template": "{{.UserName}}@{{.HostName}} : {{.Folder}}"
}

2
themes/nu4a.omp.json
View file

@ -4,7 +4,7 @@
"osc99": false,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.User}} ➔ 📁{{.Folder}}",
"console_title_template": "{{if .Root}} ⚡ {{end}}{{.UserName}} ➔ 📁{{.Folder}}",
"blocks": [
{
"type": "prompt",

2
themes/paradox.omp.json
View file

@ -19,7 +19,7 @@
"foreground": "#100e23",
"background": "#ffffff",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/plague.omp.json
View file

@ -13,7 +13,7 @@
"leading_diamond": "\uE0B6",
"trailing_diamond": "\uE0B0",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/powerlevel10k_classic.omp.json
View file

@ -64,7 +64,7 @@
"leading_diamond": "\uE0B2",
"properties": {
"postfix": " <#26C6DA>\uE0B3</> ",
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/powerline.omp.json
View file

@ -15,7 +15,7 @@
"style": "plain",
"foreground": "#ffffff",
"properties": {
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/slim.omp.json
View file

@ -43,7 +43,7 @@
"background": "#2f2f2f",
"properties": {
"postfix": "<#7a7a7a> \ue0b1</>",
"template": "{{ if ne .Env.POSH_SESSION_DEFAULT_USER .UserName }}<#77f5d6>{{ .UserName }}</><#7a7a7a>\uf1fa</><#2EEFBF>{{ end }}{{ .ComputerName }}</>"
"template": "{{ if ne .Env.POSH_SESSION_DEFAULT_USER .UserName }}<#77f5d6>{{ .UserName }}</><#7a7a7a>\uf1fa</><#2EEFBF>{{ end }}{{ .HostName }}</>"
}
},
{

2
themes/slimfat.omp.json
View file

@ -43,7 +43,7 @@
"background": "#2f2f2f",
"properties": {
"postfix": "<#7a7a7a> \ue0b1</>",
"template": "{{ if ne .Env.POSH_SESSION_DEFAULT_USER .UserName }}<#77f5d6>{{ .UserName }}</><#7a7a7a>\uf1fa</><#2EEFBF>{{ .ComputerName }}{{ end }}</>"
"template": "{{ if ne .Env.POSH_SESSION_DEFAULT_USER .UserName }}<#77f5d6>{{ .UserName }}</><#7a7a7a>\uf1fa</><#2EEFBF>{{ .HostName }}{{ end }}</>"
}
},
{

2
themes/sorin.omp.json
View file

@ -24,7 +24,7 @@
"foreground": "#FFFFFF",
"properties": {
"prefix": "",
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/stelbent.minimal.omp.json
View file

@ -48,7 +48,7 @@
"foreground": "#757575",
"properties": {
"prefix": "\u250c ",
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/thecyberden.omp.json
View file

@ -18,7 +18,7 @@
"trailing_diamond": "",
"properties": {
"prefix": "\uFCBE ",
"template": "{{ .ComputerName }}"
"template": "{{ .HostName }}"
}
},
{

2
themes/unicorn.omp.json
View file

@ -3,7 +3,7 @@
"final_space": true,
"console_title": true,
"console_title_style": "template",
"console_title_template": "{{.User}}@{{.Host}} in {{ .Path }}",
"console_title_template": "{{.UserName}}@{{.HostName}} in {{ .Path }}",
"blocks": [
{
"type": "prompt",

2
themes/xtoys.omp.json
View file

@ -19,7 +19,7 @@
"style": "plain",
"properties": {
"prefix": "",
"template": "{{ .UserName }}@{{ .ComputerName }}"
"template": "{{ .UserName }}@{{ .HostName }}"
}
},
{

2
themes/ys.omp.json
View file

@ -44,7 +44,7 @@
"style": "plain",
"properties": {
"prefix": "",
"template": "<cyan>{{ .UserName }}</> <darkGray>@</> <green>{{ .ComputerName }}</>"
"template": "<cyan>{{ .UserName }}</> <darkGray>@</> <green>{{ .HostName }}</>"
}
},
{