Project

What

Display the current version of your project defined in the package file.

Supports:

• Node.js project (package.json)
• Cargo project (Cargo.toml)
• Python project (pyproject.toml, supports metadata defined according to PEP 621 or Poetry)
• Mojo project (mojoproject.toml)
• PHP project (composer.json)
• Dart project (pubspec.yaml)
• Any nuspec based project (*.nuspec, first file match info is displayed)
• .NET project (*.sln, *.slnf, *.slnx, *.csproj, *.vbproj or *.fsproj, first file match info is displayed)
• Julia project (JuliaProject.toml, Project.toml)
• PowerShell project (*.psd1, first file match info is displayed)

Sample Configuration

json

{
  "type": "project",
  "style": "powerline",
  "powerline_symbol": "",
  "foreground": "#193549",
  "background": "#ffeb3b",
  "template": " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }} {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} "
}

yaml

type: project
style: powerline
powerline_symbol: 
foreground: "#193549"
background: "#ffeb3b"
template: " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}
  {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} "

toml

type = "project"
style = "powerline"
powerline_symbol = ""
foreground = "#193549"
background = "#ffeb3b"
template = " {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }} {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }} "

Properties

Name	Type	Default	Description
always_enabled	boolean	false	always show the segment
<type>_files	array	[]	override the project's files to validate for. Use the .Type values listed below to override (e.g. dotnet_files)

Template (info)

default template

 {{ if .Error }}{{ .Error }}{{ else }}{{ if .Version }}\uf487 {{.Version}}{{ end }} {{ if .Name }}{{ .Name }}{{ end }}{{ end }}

Properties

Name	Type	Description
.Type	string	The type of project: node cargo python mojo php dart nuspec dotnet julia powershell
.Version	string	The version of your project
.Target	string	The target framework/language version of your project
.Name	string	The name of your project
.Error	string	The error context when we can't fetch the project info