Skip to main content

Add Segment

Create the logic (Writer)​

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 (
	"github.com/jandedobbeleer/oh-my-posh/src/properties"
	"github.com/jandedobbeleer/oh-my-posh/src/runtime"
)

type New struct {
    props   properties.Properties
    env     runtime.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 runtime.Environment) {
    n.props = props
    n.env = env

    n.Text = n.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_types.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​

Add your SegmentType and Writer to the Segments map (respect the alphabetical order).

NEW: func() SegmentWriter { return &segments.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 website/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

import Config from '@site/src/components/Config.js';

<Config data={{
  "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 🏎