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

52 lines
1.4 KiB
Plaintext
Raw Normal View History

2022-03-11 06:28:25 -08:00
---
id: project
title: Project
sidebar_label: Project
---
## What
Display the current version of your project defined in the package file.
Supports:
- Node.js project (`package.json`)
- Cargo project (`Cargo.toml`)
- Poetry project (`pyproject.toml`)
- PHP project (`composer.json`)
- Any nuspec based project (`*.nuspec`, first file match info is displayed)
- .NET project (`*.csproj`, `*.vbproj` or `*.fsproj`, first file match info is displayed)
2022-03-11 06:28:25 -08:00
## Sample Configuration
```json
{
"type": "project",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#193549",
"background": "#ffeb3b",
"template": " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}\uf487 {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} "
2022-03-11 06:28:25 -08:00
}
```
## Template ([info][templates])
:::note default template
```template
{{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}\uf487 {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }}
2022-03-11 06:28:25 -08:00
```
:::
### Properties
| Name | Type | Description |
| ---------- | -------- | ---------------------------------------------------- |
| `.Version` | `string` | The version of your project |
| `.Target` | `string` | The target framwork/language version of your project |
| `.Name` | `string` | The name of your project |
2022-03-11 06:28:25 -08:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates