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

61 lines
1.8 KiB
Plaintext
Raw Normal View History

---
id: dotnet
title: Dotnet
sidebar_label: Dotnet
---
## What
Display the currently active [.NET SDK][net-sdk-docs] version.
## Sample Configuration
```json
{
"type": "dotnet",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#000000",
"background": "#00ffff",
2022-03-27 01:12:47 -07:00
"template": " \uE77F {{ .Full }} "
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
2022-01-22 10:46:56 -08:00
- fetch_version: `boolean` - fetch the active version or not; useful if all you need is an icon indicating `dotnet`
is present - defaults to `true`
2020-12-31 22:15:19 -08:00
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
2021-01-22 09:44:40 -08:00
- display_mode: `string` - determines when the segment is displayed
2021-02-03 23:38:55 -08:00
- `always`: the segment is always displayed
- `files`: the segment is only displayed when `*.cs`, `*.vb`, `*.fs`, `*.fsx`, `*.sln`, `*.slnf`, `*.csproj`, `*.vbproj`,
2021-10-16 22:56:15 -07:00
or `*.fsproj` files are 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
2021-11-07 10:55:22 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
``` template
{{ if .Unsupported }}\uf071{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
2021-11-07 10:55:22 -08:00
2021-12-03 11:36:30 -08:00
- `.Full`: `string` - the full version
- `.Major`: `string` - major number
- `.Minor`: `string` - minor number
- `.Patch`: `string` - patch number
- `.Prerelease`: `string` - prerelease info text
- `.BuildMetadata`: `string` - build metadata
- `.URL`: `string` - URL of the version info / release notes
- `.Error`: `string` - error encountered when fetching the version string
2021-11-07 10:55:22 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
[net-sdk-docs]: https://docs.microsoft.com/en-us/dotnet/core/tools