Segment Create

Implementation steps

1. Create Go writer file: src/segments/<id>.go

• If file exists, skip creation.
• Use this template; include property consts for each property key.

package segments

import (
    "github.com/jandedobbeleer/oh-my-posh/src/segments/options"
    "github.com/jandedobbeleer/oh-my-posh/src/runtime"
)

type {{goType}} struct {
    Base

    // computed fields used in template
    Text string
}

// properties
const (
{{#each properties}}
    // {{this.title}}: {{this.description}}
    {{ pascalCase this.key }} options.Property = "{{this.key}}"
{{/each}})

func (s *{{goType}}) Enabled() bool {
    // set up data for the template, using defaults from properties
    {{#if (propExists properties "text")}}
    s.Text = s.props.GetString({{ pascalCase "text" }}, {{ defaultFor "text" }})
    {{else}}
    s.Text = s.props.GetString({{ pascalCase (firstKey properties) }}, "")
    {{/if}}
    return true
}

func (s *{{goType}}) Template() string {
    return {{ printf "%q" template }}
}

1. Register in src/config/segment_types.go

• Ensure in init() there is gob.Register(&segments.{{goType}}{}) exactly once.
• Add constant: {{ upper id }} SegmentType = "{{id}}" in the alphabetical block.
• Add to var Segments = map[SegmentType]func() SegmentWriter{} with key {{ upper id }} mapping to &segments.{{goType}}{}.
• Keep lists alphabetically sorted. If not sorted, insert at correct position.

1. Documentation file

• Consult the segment-docs skill (.github/skills/segment-docs/SKILL.md) for the Go-to-documentation type mapping and rules for extracting options and template properties.
• Path: website/docs/segments/{{category}}/{{id}}.mdx.
• If file exists, skip. Else create with this template:

---