docs: add subversion schema + info

This commit is contained in:
Jan De Dobbeleer 2022-06-05 16:33:13 +02:00 committed by Jan De Dobbeleer
parent 7b6f791026
commit 5b2ba33b98
3 changed files with 35 additions and 11 deletions

View file

@ -226,6 +226,7 @@
"shell", "shell",
"sysinfo", "sysinfo",
"strava", "strava",
"svn",
"swift", "swift",
"time", "time",
"text", "text",
@ -1886,6 +1887,31 @@
} }
} }
}, },
{
"if": {
"properties": {
"type": {
"const": "svn"
}
}
},
"then": {
"title": "SVN Segment",
"description": "https://ohmyposh.dev/docs/segments/svn",
"properties": {
"properties": {
"properties": {
"fetch_status": {
"type": "boolean",
"title": "Display Status",
"description": "Display the local changes or not",
"default": true
}
}
}
}
}
},
{ {
"if": { "if": {
"properties": { "properties": {

View file

@ -1,12 +1,12 @@
--- ---
id: svn id: svn
title: Svn title: Subversion
sidebar_label: Svn sidebar_label: Subversion
--- ---
## What ## What
Display svn information when in a svn repository. Also works for subfolders. For maximum compatibility, Display subversion information when in a subversion repository. Also works for subfolders. For maximum compatibility,
make sure your `svn` executable is up-to-date (when branch or status information is incorrect for example). make sure your `svn` executable is up-to-date (when branch or status information is incorrect for example).
Local changes can also be displayed which uses the following syntax: Local changes can also be displayed which uses the following syntax:
@ -16,7 +16,6 @@ Local changes can also be displayed which uses the following syntax:
- `-` deleted - `-` deleted
- `~` modified - `~` modified
- `>` moved - `>` moved
- `?` untracked
## Sample Configuration ## Sample Configuration
@ -28,10 +27,7 @@ Local changes can also be displayed which uses the following syntax:
"foreground": "#193549", "foreground": "#193549",
"background": "#ffeb3b", "background": "#ffeb3b",
"properties": { "properties": {
"fetch_status": true, "fetch_status": true
"fetch_stash_count": true,
"fetch_upstream_icon": true,
"template": " \ue0a0{{ .Branch }} r{{ .BaseRev }} {{ .Working.String }} "
} }
} }
``` ```
@ -40,7 +36,7 @@ Local changes can also be displayed which uses the following syntax:
### Fetching information ### Fetching information
As doing multiple svn calls can slow down the prompt experience, we do not fetch information by default. As doing multiple [subversion][svn] calls can slow down the prompt experience, we do not fetch information by default.
You can set the following properties to `true` to enable fetching additional information (and populate the template). You can set the following properties to `true` to enable fetching additional information (and populate the template).
- fetch_status: `boolean` - fetch the local changes - defaults to `false` - fetch_status: `boolean` - fetch the local changes - defaults to `false`
@ -63,14 +59,15 @@ You can set the following properties to `true` to enable fetching additional inf
### SvnStatus ### SvnStatus
- `.Untracked`: `int` - number of untracked files - `.Modified`: `int` - number of modified files
- `.Deleted`: `int` - number of deleted files - `.Deleted`: `int` - number of deleted files
- `.Added`: `int` - number of added files - `.Added`: `int` - number of added files
- `.Tracked`: `int` - number of changed tracked files - `.Moved`: `int` - number of changed moved files
- `.Conflicted`: `int` - number of changed tracked files with conflicts - `.Conflicted`: `int` - number of changed tracked files with conflicts
- `.Changed`: `boolean` - if the status contains changes or not - `.Changed`: `boolean` - if the status contains changes or not
- `.HasConflicts`: `boolean` - if the status contains conflicts or not - `.HasConflicts`: `boolean` - if the status contains conflicts or not
- `.String`: `string` - a string representation of the changes above - `.String`: `string` - a string representation of the changes above
[svn]: https://subversion.apache.org
[templates]: /docs/config-templates [templates]: /docs/config-templates
[hyperlinks]: /docs/config-templates#helper-functions [hyperlinks]: /docs/config-templates#helper-functions

View file

@ -98,6 +98,7 @@ module.exports = {
"segments/shell", "segments/shell",
"segments/spotify", "segments/spotify",
"segments/strava", "segments/strava",
"segments/svn",
"segments/swift", "segments/swift",
"segments/sysinfo", "segments/sysinfo",
"segments/terraform", "segments/terraform",