oh-my-posh/website/docs/segments/nx.mdx

62 lines
3.2 KiB
Plaintext
Raw Normal View History

2022-05-26 05:51:26 -07:00
---
id: nx
title: Nx
sidebar_label: Nx
---
## What
Display the currently active [Nx][nx-docs] version.
## Sample Configuration
2024-01-13 02:11:22 -08:00
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "nx",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#000000",
background: "#1976d2",
template: " \uE753 {{ .Full }} ",
}}
/>
2022-05-26 05:51:26 -07:00
## Properties
2024-01-13 02:11:22 -08:00
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `workspace.json` or `nx.json` file is present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
2024-01-21 05:14:26 -08:00
| `folders` | `[]string` | allows to override the list of folder names to validate |
2024-01-13 02:11:22 -08:00
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
2022-05-26 05:51:26 -07:00
## Template ([info][templates])
:::note default template
```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
| Name | Type | Description |
| -------- | -------- | -------------------------------------------------- |
| `.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 |
2022-05-26 05:51:26 -07:00
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates
[nx-docs]: https://nx.dev