Skip to main content

Add Segment

Create the logicโ€‹

Add a new file in the ./src/segments folder: new.go. Ensure New is a single verb indicating the context the segment renders.

You can use the following template as a guide.

package segments

import (
"oh-my-posh/environment"
"oh-my-posh/properties"
)

type New struct {
props properties.Properties
env environment.Environment

Text string
}

const (
//NewProp enables something
NewProp properties.Property = "newprop"
)

func (n *new) Enabled() bool {
return true
}

func (n *new) Template() string {
return " {{.Text}} world "
}

func (n *new) Init(props properties.Properties, env environment.Environment) {
n.props = props
n.env = env

n.Text = props.GetString(NewProp, "Hello")
}

When it comes to icon Properties, make sure to use the UTF32 representation (e.g. "\uEFF1") rather than the icon itself. This will facilitate the review process as not all environments display the icons based on the font being used. You can find these values and query for icons easily at Nerd Fonts.

For each segment, there's a single test file ensuring the functionality going forward. The convention is new_test.go, have a look at existing segment tests for inspiration. Oh My Posh makes use of the test tables pattern for all newly added tests. See this blog post for more information.

Create a name for your Segmentโ€‹

segment.go contains the list of available SegmentType's, which gives them a name we can map from the .json themes.

Add your segment.

// NEW is brand new
NEW SegmentType = "new"

Add the SegmentType mappingโ€‹

Map your SegmentType to your Segment in the mapSegmentWithWriter function (respect the alphabetical order).

NEW: &New{},

Test your functionalityโ€‹

Even with unit tests, it's a good idea to build and validate the changes:

go build -o $GOPATH/bin/oh-my-posh

Add the documentationโ€‹

Create a new markdown file underneath the docs/docs/segments folder called new.md. Use the following template as a guide.

---
id: new
title: New
sidebar_label: New
---

## What

Display something new.

## Sample Configuration

```json
{
"type": "new",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#193549",
"background": "#ffeb3b",
"properties": {
"newprop": "\uEFF1"
}
}
```

## Properties

| Name | Type | Description |
| --------- | -------- | ------------------------------------------- |
| `newprop` | `string` | the new text to show - defaults to `\uEFF1` |

Map the new documentation in the sidebarโ€‹

Open sidebars.js and add your document id (new) to the items of the Segments category.

Add the JSON schemaโ€‹

Edit the themes/schema.json file to add your segment.

At $.definitions.segment.properties.type.enum, add your SegmentType to the array:

new,

At $.definitions.segment.allOf, add your segment details:

{
"if": {
"properties": {
"type": { "const": "new" }
}
},
"then": {
"title": "Display something new",
"description": "https://ohmyposh.dev/docs/new",
"properties": {
"properties": {
"properties": {
"newprop": {
"type": "string",
"title": "New Property",
"description": "the default text to display",
"default": "Hello"
}
}
}
}
}
}

Create a pull requestโ€‹

And be patient, I'm going as fast as I can ๐ŸŽ