Sjablonen

Onofficiële Beta-vertaling

Deze pagina is vertaald door PageTurner AI (beta). Niet officieel goedgekeurd door het project. Een fout gevonden? Probleem melden →

Elk segment heeft een template-eigenschap om de weergegeven tekst aan te passen. Onder de motorkap gebruikt dit Go's text/template-functie uitgebreid met sprig, en biedt het enkele standaardeigenschappen om mee te werken.

Globale eigenschappen

Deze eigenschappen kunnen overal gebruikt worden, in elk segment. Als een segment een eigenschap met dezelfde naam bevat, wordt de segmentwaarde gebruikt. Als je de globale eigenschap wilt gebruiken, kun je deze direct benaderen door .$ als voorvoegsel te gebruiken.

Name	Type	Description
`.Root`	`boolean`	is the current user root/admin or not
`.PWD`	`string`	the current working directory (`~` for `$HOME`)
`.AbsolutePWD`	`string`	the current working directory (unaltered)
`.PSWD`	`string`	the current non-filesystem working directory in PowerShell
`.Folder`	`string`	the current working folder
`.Shell`	`string`	the current shell name. The value may be overriden by `maps.shell_name`.
`.ShellVersion`	`string`	the current shell version
`.SHLVL`	`int`	the current shell level
`.UserName`	`string`	the current user name
`.HostName`	`string`	the host name
`.Code`	`int`	the last exit code
`.Jobs`	`int`	number of background jobs (only available for zsh, PowerShell, and Nushell)
`.OS`	`string`	the operating system
`.WSL`	`boolean`	in WSL yes/no
`.Templates`	`string`	the templates result
`.PromptCount`	`int`	the prompt counter, increments with 1 for every prompt invocation
`.Version`	`string`	the Oh My Posh version
`.Segment`	`Segment`	the current segment's metadata

Segment

Name	Type	Description
`.Segment.Index`	`int`	the current segment's index (as rendered)
`.Segment.Text`	`string`	the segment's rendered text

Omgevingsvariabelen

Name	Type	Description
`.Env.VarName`	`string`	Any environment variable where `VarName` is the environment variable name

tip

Voor de onderstaande shells kun je een functie overschrijven om logica uit te voeren voordat de prompt wordt weergegeven. Dit kan bijvoorbeeld worden gebruikt om een omgevingsvariabele te vullen met een specifieke context.

powershell
zsh
bash
fish
nu

function Set-EnvVar([bool]$originalStatus) {
    $env:POSH=$(Get-Date)
}
New-Alias -Name 'Set-PoshContext' -Value 'Set-EnvVar' -Scope Global -Force

function set_poshcontext() {
    export POSH=$(date)
}

function set_poshcontext() {
    export POSH=$(date)
}

function set_poshcontext
  set --export POSH $(date)
end

$env.SET_POSHCONTEXT = {
	$env.POSH = ( date now );
}

Configuratievariabelen

Name	Type	Description
`.Var.VarName`	`any`	Any config variable where `VarName` is the variable name

Voorbeeld

json
yaml
toml

{
  "version": 4,
  "var": {
    "Hello": "hello",
    "World": "world"
  },
  "blocks": [
    {
      "type": "prompt",
      "alignment": "left",
      "segments": [
        {
          "type": "text",
          "style": "plain",
          "foreground": "p:white",
          "template": "{{ .Var.Hello }} {{ .Var.World }} "
        }
      ]
    }
  ]
}

version: 4
var:
  Hello: hello
  World: world
blocks:
  - type: prompt
    alignment: left
    segments:
      - type: text
        style: plain
        foreground: p:white
        template: "{{ .Var.Hello }} {{ .Var.World }} "

version = 4

[var]
Hello = "hello"
World = "world"

[[blocks]]
type = "prompt"
alignment = "left"

[[blocks.segments]]
type = "text"
style = "plain"
foreground = "p:white"
template = "{{ .Var.Hello }} {{ .Var.World }} "

Sjabloonlogica

Template	Description
`{{.}}`	Root element.
`{{.Var}}`	Variable in a struct, where Var is a variable.
`{{- .Var -}}`	Remove extra white space surrounding the .Var variable and remove the newline. Either side is fine too.
`{{ $planet := "Earth"}}`	`{{ $planet }}` Store a value in a custom variable to reference later. Note that .$ is used to reference the global/parent context, like in the full example below with $.
`Hi {{if .Name}} {{.Name}} {{else}} visitor {{end}}`	If-else statement. If will evaluate whether or not the argument is empty. Using the elseif conditional is also an option. The not negation is available too.
`{{if and .Arg1 .Arg2}} both complete. {{else}} incomplete. {{end}}`	The and function compares multiple arguments to return the boolean AND (if arg1 then arg2 else arg1). Both arguments are evaluated. The or function compares multiple arguments to return the boolean OR. Similar to if arg1 then arg1 else arg2, so arg2 will never be evaluated if arg1 is false (not empty).
`{{with .Var}} {{end}}`	With statement, where Var is a variable. It skips the block if the variable is absent.
`{{range .Array}} {{end}}`	Range statement, where Array is an array, slice, map, or channel.
`{{ lt 3 4 }}`	This lt comparison function evaluates to true since 3 is less than 4 (other boolean operators: eq, ne, lt, le, gt, ge).

Helperfuncties

Sprig

Oh My Posh bevat alle sprig-functies, wat betekent dat je bewerkingen op strings, paden en vele andere manipulaties direct vanuit je sjabloon kunt uitvoeren. Bekijk hun documentatie voor beschikbare opties en gebruiksinstructies.

Aangepast

Template	Description
`{{ url .UpstreamIcon .UpstreamURL }}`	Create an `OSC8` hyperlink to a website to open your default browser (needs terminal support).
`{{ path .Path .Location }}`	Create an `OSC8` file link to a folder to open your file explorer (needs terminal support).
`{{ secondsRound 3600 }}`	Round seconds to a time indication. In this case the output is `1h`.
`{{ if glob "*.go" }}OK{{ else }}NOK{{ end }}`	Exposes filepath.Glob as a boolean template function.
`{{ if matchP ".*\\.Repo$" .Path }}Repo{{ else }}No Repo{{ end }}`	Exposes regexp.MatchString as a boolean template function.
`{{ replaceP "c.t" "cut code cat" "dog" }}`	Exposes regexp.ReplaceAllString as a string template function.
`{{ .Code \| hresult }}`	Transform a status code to its HRESULT value for easy troubleshooting. For example `-1978335212` becomes `0x8A150014`.
`{{ readFile ".version.json" }}`	Read a file in the current directory. Returns a string.
`{{ random (list \"a\" 2 .MyThirdItem) }}`	Selects a random element from a list. The list can be an array or slice containing any types (use sprig's `list`).

Sjablooneigenschappen over segmenten heen

Om eigenschappen van een ander segment in een sjabloon te gebruiken, kun je {{ .Segments.Segment }} gebruiken waarbij .Segment de naam is van het gewenste segment met een hoofdletter aan het begin.

Als je bijvoorbeeld de .UpstreamGone-eigenschap van het git-segment wilt gebruiken in het status-segment, kun je dat als volgt doen:

json
yaml
toml

{
  "template": " {{ if .Segments.Git.UpstreamGone }}{{ else if gt .Code 0 }}{{ else }}{{ end }} "
}

template: " {{ if .Segments.Git.UpstreamGone }}{{ else if gt .Code 0 }}{{ else
  }}{{ end }} "

template = " {{ if .Segments.Git.UpstreamGone }}{{ else if gt .Code 0 }}{{ else }}{{ end }} "

let op

Let op: het segment waarnaar je verwijst moet wel in je configuratie staan. Het bovenstaande voorbeeld werkt niet als je configuratie geen git-segment bevat, omdat Oh My Posh alleen eigenschappen invult wanneer dat nodig is.

tip

Als je twee identieke segmenten voor verschillende doeleinden hebt, kun je de alias-eigenschap gebruiken om onderscheid te maken.

json
yaml
toml

{
  "segments": [
    {
      "type": "git",
      "alias": "GitMain",
      "style": "plain",
      "foreground": "#ffffff",
      "options": {
        "branch_icon": ""
      }
    },
    {
      "type": "git",
      "alias": "GitSecondary",
      "style": "plain",
      "foreground": "#ffffff",
      "options": {
        "branch_icon": ""
      }
    },
    {
      "type": "text",
      "style": "plain",
      "foreground": "#ffffff",
      "template": "{{ .Segments.GitMain.HEAD }} - {{ .Segments.GitSecondary.HEAD }}"
    }
  ]
}

segments:
  - type: git
    alias: GitMain
    style: plain
    foreground: "#ffffff"
    options:
      branch_icon: ""
  - type: git
    alias: GitSecondary
    style: plain
    foreground: "#ffffff"
    options:
      branch_icon: ""
  - type: text
    style: plain
    foreground: "#ffffff"
    template: "{{ .Segments.GitMain.HEAD }} - {{ .Segments.GitSecondary.HEAD }}"

[[segments]]
type = "git"
alias = "GitMain"
style = "plain"
foreground = "#ffffff"

[segments.options]
branch_icon = ""

[[segments]]
type = "git"
alias = "GitSecondary"
style = "plain"
foreground = "#ffffff"

[segments.options]
branch_icon = ""

[[segments]]
type = "text"
style = "plain"
foreground = "#ffffff"
template = "{{ .Segments.GitMain.HEAD }} - {{ .Segments.GitSecondary.HEAD }}"

Om te controleren of een specifiek segment actief is, kun je de .Segments.Contains-functie gebruiken, bijvoorbeeld:

json
yaml
toml

{
  "template": "{{ if .Segments.Contains \"Git\" }}{{ else if gt .Code 0 }}{{ else }}{{ end }} "
}

template: '{{ if .Segments.Contains "Git" }}{{ else if gt .Code 0 }}{{ else
  }}{{ end }} '

template = "{{ if .Segments.Contains \"Git\" }}{{ else if gt .Code 0 }}{{ else }}{{ end }} "

Tekstdecoratie

Je kunt de volgende syntax gebruiken om tekst te decoreren:

Syntax	Description
`<b>bold</b>`	`bold` as bold text
`<u>underline</u>`	`underline` as underlined text
`<o>overline</o>`	`overline` as overlined text
`<i>italic</i>`	`italic` as italic text
`<s>strikethrough</s>`	`strikethrough` as strikethrough text
`<d>dimmed</d>`	`dimmed` as dimmed text
`<f>blink</f>`	`blink` as blinking (flashing) text
`<r>reversed</r>`	`reversed` as reversed text

Deze kan worden gebruikt in sjablonen en iconen/tekst binnen je configuratie.

Globale eigenschappen​

Segment​

Omgevingsvariabelen​

Configuratievariabelen​

Voorbeeld​

Sjabloonlogica​

Helperfuncties​

Sprig​

Aangepast​

Sjablooneigenschappen over segmenten heen​

Tekstdecoratie​