mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-03-05 20:49:04 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update contributing guide

Browse source
This commit is contained in:
Jan De Dobbeleer 2021-11-22 13:27:04 +01:00 committed by Jan De Dobbeleer
parent d422325f98
commit 862d37bb7b
1 changed files with 30 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/docs/contributing-segment.md
View file

@ -17,10 +17,12 @@ package main
type new struct { type new struct {
props *properties props *properties
env environmentInfo env environmentInfo
Text string
} }
const ( const (
//NewProp switches something //NewProp enables something
NewProp Property = "newprop" NewProp Property = "newprop"
) )
@ -29,8 +31,21 @@ func (n *new) enabled() bool {
} }
func (n *new) string() string { func (n *new) string() string {
newText := n.props.getString(NewProp, "\uEFF1") useDefaultText := n.props.getBool(NewProp, true)
return newText if useDefaultText {
n.Text = "Hello"
}
segmentTemplate := a.props.getString(SegmentTemplate, "{{.Text}} world")
template := &textTemplate{
Template: segmentTemplate,
Context: n,
Env: n.env,
}
text, err := template.render()
if err != nil {
return err.Error()
}
return text
} }
func (n *new) init(props *properties, env environmentInfo) { func (n *new) init(props *properties, env environmentInfo) {
@ -39,12 +54,16 @@ func (n *new) init(props *properties, env environmentInfo) {
} }
``` ```
When it comes to properties, make sure to use the UTF32 representation (e.g. "\uEFF1") rather than the icon itself. 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. 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][nf-icons]. You can find these values and query for icons easily at [Nerd Fonts][nf-icons].
For each segment, there's a single test file ensuring the functionality going forward. The convention For each segment, there's a single test file ensuring the functionality going forward. The convention
is `new_segment_test.go`, have a look at existing segment tests for inspiration. is `new_segment_test.go`, have a look at [existing segment tests][tests] for inspiration. Oh My Posh makes
use of the test tables pattern for all newly added tests. See [this][tables] blog post for more information.
The use of a `SegmentTemplate` is required. We're currentlly in the process of refactoring all segments to use
a template. As soon as this work is done, the templating logic will move outside of the segment's logic.
## Create a name for your Segment ## Create a name for your Segment
@ -140,10 +159,10 @@ At `$.definitions.segment.allOf`, add your segment details:
"properties": { "properties": {
"properties": { "properties": {
"nwprop": { "nwprop": {
"type": "string", "type": "boolean",
"title": "New Prop", "title": "New Property",
"description": "the new text to show", "description": "the default text to display",
"default": "\uEFF1" "default": "Hello"
} }
} }
} }
@ -161,3 +180,5 @@ And be patient, I'm going as fast as I can 🏎
[docs]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/docs/docs [docs]: https://github.com/JanDeDobbeleer/oh-my-posh/tree/main/docs/docs
[sidebars]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/docs/sidebars.js [sidebars]: https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/docs/sidebars.js
[nf-icons]: https://www.nerdfonts.com/cheat-sheet [nf-icons]: https://www.nerdfonts.com/cheat-sheet
[tests]: hhttps://github.com/JanDeDobbeleer/oh-my-posh/blob/main/src/segment_az_test.go
[tables]: https://blog.alexellis.io/golang-writing-unit-tests/