oh-my-posh/website/docs/segments/nx.mdx
2022-06-03 20:42:25 +02:00

56 lines
1.4 KiB
Plaintext

---
id: nx
title: Nx
sidebar_label: Nx
---
## What
Display the currently active [Nx][nx-docs] version.
## Sample Configuration
```json
{
"type": "nx",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#000000",
"background": "#1976d2",
"template": " \uE753 {{ .Full }} "
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
- fetch_version: `boolean` - fetch the active version or not; useful if all you need is an icon indicating `ng`
- display_mode: `string` - determines when the segment is displayed
- `always`: the segment is always displayed
- `files`: the segment is only displayed when `workspace.json` file is present (default)
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
the URL of the version info / release notes
## Template ([info][templates])
:::note default template
```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
- `.Full`: `string` - the full version
- `.Major`: `string` - major number
- `.Minor`: `string` - minor number
- `.Patch`: `string` - patch number
- `.URL`: `string` - URL of the version info / release notes
- `.Error`: `string` - error encountered when fetching the version string
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates
[nx-docs]: https://nx.dev