clanker 0.2.0

Minimalistic command prompt for fish.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# clanker

[![Crates.io](https://img.shields.io/crates/v/clanker.svg)](https://crates.io/crates/clanker)

Clanker is a minimalistic set of command prompts for fish.

## Usage

First, install the package via `cargo install clanker`.

Then put this in your `config.fish` or somewhere that will be sourced, ensuring
that the location `cargo` installs to is in your `PATH`:

```fish
function fish_prompt
    clanker-prompt
end

function fish_right_prompt
    clanker-right-prompt "$status"
end

function fish_title
    clanker-title "$_"
end
```

### `clanker-prompt`

`clanker-prompt` takes no arguments and outputs the current username, hostname,
and compressed directory. Compression of the current working directory is as
expected - if in the current user's home directory, the prefix is substituted
with `~`. If in another user's home directory, the prefix is substituted with
`~USER`. If there is more than one component in the path, all components but
the last are trimmed to one or two extended grapheme clusters. Components are
trimmed to two extended grapheme clusters if a) they begin with a `.` or b)
they begin with a `~` and also are the first component in the path - in other
words, when we did prefix shortening to `~USER/other/path/components`.

### `clanker-right-prompt`

`clanker-right-prompt` optionally takes the status of the last command as an
argument. If the status was provided and was nonzero, it is printed in red. In
addition, if the current directory is a git repository according to the
behavior when running `git_repository_open_ext` with
`REPOSITORY_OPEN_FROM_ENV`, the current branch or checkout out commit ID will
be printed. If there are changes that would show up in `git status`, this will
be indicated with a `*`.

### `clanker-title`

`clanker-title` optionally takes the currently running program as an argument
and prints it along with the compressed current working directory.