Commit graph

4 commits

Author SHA1 Message Date
Jan De Dobbeleer f891a26fe9 docs(sidebar): restructure segment layout
resolves #5171
2024-07-05 12:31:42 +02:00
ivan-the-terrible 2b5a62386b docs: add default column to properties table 2024-04-17 13:24:18 +02:00
Jan De Dobbeleer c079e6eacf docs(status): use correct template 2023-08-02 07:28:40 +02:00
Jan De Dobbeleer f47da9592f feat(exit): implement pipestatus
BREAKING CHANGE: exit segment is now called status segment.

The exit keyword is now deprecated and will be removed in a future
release. Please use the status keyword instead:

```diff
"segments": {
    {
-     "type": "exit"
+     "type": "status"
    }
}
```

Additionally, the status segment configuration has changed to support
$PIPESTATUS. You can include a status template to customize the
rendering of each individual status code (supported in fish, zsh and
bash).

```json
"segments": {
    {
        "type": "status",
        "properties": {
            "status_template": "{{ if gt .Code 0 }}\uf071{{ else }}\uf00c{{ end }}",
            "status_separator": " "
        }
    }
}
```

In case no $PIPESTATUS is available, the status segment will fall back
to the exit code of the last command using the status template
for rendering.

The `{{ .Meaning }}` property has been marked as deprecated and can be
replaced with `{{ reason .Code }}`, allowing it to be reused in
cross segment templates.

resolves #4070
2023-07-24 11:46:33 +02:00