Skip to main content

Get Started

Get the source code​

The source is hosted on Github. When you want to contribute, create a fork so you can make changes in your repository and create a pull request in the official Oh My Posh repository.

To clone your fork of Oh My Posh locally, open the terminal and replace <user> with your Github username.

git clone git@github.com:<user>/oh-my-posh.git

Install dependencies​

go​

The codebase is in go, meaning we need a working go setup before we can do anything else. Have a look at the go guide to get up and running with go in no time!

caution

Oh My Posh needs at least go 1.22

golangci-lint​

To make sure we keep on writing quality code, golang-ci lint is used to validate the changes. Have a look at the local installation guide to make sure you can validate this yourself as well.

nodejs​

The documentation is written in markdown and uses Docusaurus to generate the website. To validate your changes, you'll need to have nodejs installed so you can run the website locally.

Visual Studio Code​

If you're not using Visual Studio Code yet, it's a great editor to work with go and the project has the configuration built-in. You can download it here.

Configure Visual Studio Code​

A default config (.vscode folder) for Visual Studio Code is available in the repo:

  • golangci-lint is configured as the default linter.
  • recommended extensions available for a smooth bootstrap.
  • default run and debug configurations available.

Once the extensions are installed:

  • debug can be started by hitting F5.
  • all tests can be run using the Test explorer.

Running tests​

The go source code can be found in the src/ directory, make sure to navigate to that one before continuing.

Unit tests​

go test -v ./...

golangci-lint​

golangci-lint run

Building the app​

The easiest way to validate your changes is to write tests. Unfortunately, as it's a visual tool, you'll want to validate the changes by running the prompt in your shell as well.

If you already have Oh My Posh in your PATH, you'll need to either use that one as an output parameter, or make sure that the $GOPATH/bin/ folder precedes the Oh My Posh binary in your PATH.

go build -o (Get-Command oh-my-posh.exe).Source

Alternatively:

$env:PATH = "$env:GOPATH\bin;$env:PATH"
go build -o $GOPATH/bin/oh-my-posh

Run the website locally​

Open your terminal and navigate to the website folder in the repository. Install the dependencies and start the website:

npm install
npm start

This will start a local server on http://localhost:3000 where you can see your changes.

Extra tips​

Configure Delve in VS Code​

Delve config is restrictive by default(string limit especially). You can expand some limits in VS Code(settings.json or directly in launch.json):

"go.delveConfig": {

  "dlvLoadConfig": {
    "followPointers": true,
    "maxVariableRecurse": 3,
    "maxStringLen": 400,
    "maxArrayValues": 400,
    "maxStructFields": -1
  },
  "apiVersion": 2,
  "showGlobalVariables": false
}

Up Next​

With everything set up, you're ready to start making changes and create your first PR!