Aller au contenu principal

Premiers pas

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Récupérer le code source​

Le code source est hébergé sur GitHub. Pour contribuer, créez un fork qui vous permettra d'effectuer des modifications dans votre dépôt puis d'ouvrir une pull request dans le dépôt officiel d'Oh My Posh.

Pour cloner votre fork d'Oh My Posh en local, ouvrez le terminal et remplacez <user> par votre nom d'utilisateur GitHub.

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

Installer les dépendances​

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!

attention

Oh My Posh needs at least go 1.25.5

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.

Configurer Visual Studio Code​

Une configuration par défaut (dossier .vscode) pour Visual Studio Code est disponible dans le dépôt :

  • golangci-lint est configuré comme linter par défaut.

  • des extensions recommandées sont disponibles pour un démarrage simplifié.

  • des configurations d'exécution et de débogage par défaut sont disponibles.

Une fois les extensions installées :

  • le débogage peut être lancé en appuyant sur F5.

  • tous les tests peuvent être exécutés via l'explorateur de tests.

Exécuter les tests​

Le code source Go se trouve dans le dossier src/, assurez-vous de naviguer vers celui-ci avant de continuer.

Tests unitaires​

go test -v ./...

golangci-lint​

golangci-lint run

Compiler l'application​

La façon la plus simple de valider vos modifications est d'écrire des tests. Cependant, comme il s'agit d'un outil visuel, vous devrez également valider les modifications en exécutant l'invite de commande dans votre shell.

Si Oh My Posh est déjà dans votre PATH, vous devrez soit l'utiliser comme paramètre de sortie, soit vous assurer que le dossier $GOPATH/bin/ précède le binaire Oh My Posh dans votre PATH.

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

Alternative :

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

Exécuter le site localement​

Ouvrez votre terminal et naviguez vers le dossier website du dépôt. Installez les dépendances et démarrez le site :

npm install
npm start

Cela démarrera un serveur local sur http://localhost:3000 où vous pourrez voir vos modifications.

Conseils supplémentaires​

Configurer Delve dans VS Code​

La configuration de Delve est restrictive par défaut (notamment la limite de chaînes). Vous pouvez étendre certaines limites dans VS Code (settings.json ou directement dans launch.json) :

"go.delveConfig": {

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

Prochaines étapes​

Maintenant que tout est configuré, vous êtes prêt à apporter des modifications et créer votre première PR !