mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2026-08-24 02:34:19 -05:00

Files

T

4e46ca7dec docs(agents): add gob.Register step to segment development checklist

Update the segment development section to list five required artifacts
instead of four, adding the gob.Register call in segment_types.go as
step 5 with a note that omitting it causes silent runtime failures.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

2026-05-18 16:02:35 +02:00

2.7 KiB

Raw Blame History

GitHub Copilot Instructions

For general coding guidelines, commit conventions, and agent workflows, see AGENTS.md.

Tech Stack

Layer	Technology
Core engine	Go (module root: `src/`)
Documentation site	Docusaurus (MDX) - `website/`
Themes	JSON - `themes/`
Config format	TOML / JSON / YAML
Package/installer scripts	`packages/`
Build scripts	`build/`

Repository Layout

src/
  segments/   # One Go file + one _test.go per segment
  prompt/     # Core rendering engine
  runtime/    # OS/shell abstraction layer
themes/       # Bundled JSON theme files
website/      # Docusaurus docs site (MDX pages, sidebar config, JSON schema)
packages/     # Installer/package manifests
build/        # CI build helpers

Segment Development

When adding a new segment, four artifacts are required - use the segment-create skill to scaffold all of them automatically:

src/segments/<name>.go - segment implementation
src/segments/<name>_test.go - unit tests
website/docs/segments/<name>.mdx - user-facing docs
Update website/sidebars.js and website/static/schema.json
Register the type in src/config/segment_types.go via gob.Register(&segments.MySegment{}) - missing this causes silent failures at runtime

See the segment-docs skill for the canonical mapping between Go source constructs and MDX documentation fields (template properties, type representations, option tables).

Go Conventions

Follow the golang skill for project-specific Go standards.
Each segment implements the Segment interface; use env (the Environment abstraction) for all OS/shell calls - never call OS APIs directly.
Test with go test ./... from src/.
Lint with golangci-lint run from src/.

Documentation (website/)

Follow the markdown skill for .md/.mdx formatting rules.
Segment doc pages live in website/docs/segments/ and use MDX frontmatter with title, sidebar_label, and id.
Run npm run start inside website/ for a local dev server.
Run npm run build inside website/ to verify the site builds before opening a docs PR.

PowerShell

PowerShell helper scripts live in packages/ and build/. Follow the powershell skill for cmdlet conventions.

Themes

Themes are plain JSON files in themes/. New themes must validate against website/static/schema.json. Do not introduce breaking schema changes without updating the schema file.

2.7 KiB Raw Blame History