1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-18 03:40:08 +00:00
ohmyzsh/plugins/shrink-path/README.md
Pavel N. Krivitsky e65bce8495
shrink-path: add minimum length and ellipsis symbol options (#7382)
* Added minimum length and ellipsis symbol options for the shrink-path plugin.

* Replaced tab indentation with space indentation for the shrink-path plugin.

* Added handling of multicharacter ellipsis, and updated documentation and README for the shrink-path plugin.
2020-03-02 13:30:52 +01:00

74 lines
2 KiB
Markdown

# A plugin to shrink directory paths for brevity and pretty-printing
## Examples
For this directory tree:
```
/home/
me/
foo/
bar/
quux/
biz/ # The prefix b is ambiguous between bar and biz.
```
here are the results of calling `shrink_path <option> /home/me/foo/bar/quux`:
```
Option Result
<none> /h/m/f/ba/q
-l|--last /h/m/f/ba/quux
-s|--short /h/m/f/b/q
-t|--tilde ~/f/ba/q
-f|--fish ~/f/b/quux
-3 /hom/me/foo/bar/quu
-e '$' -3 /ho$/me/foo/bar/qu$
```
## Usage
For a fish-style working directory in your command prompt, add the following to
your theme or zshrc:
```
setopt prompt_subst
PS1='%n@%m $(shrink_path -f)>'
```
The following options are available:
```
-f, --fish fish simulation, equivalent to -l -s -t.
-l, --last Print the last directory's full name.
-s, --short Truncate directory names to the number of characters given by -. Without
-s, names are truncated without making them ambiguous.
-t, --tilde Substitute ~ for the home directory.
-T, --nameddirs Substitute named directories as well.
-# Truncate each directly to at least this many characters inclusive of the
ellipsis character(s) (defaulting to 1).
-e SYMBOL Postfix symbol(s) to indicate that a directory name had been truncated.
```
The long options can also be set via zstyle, like
```
zstyle :prompt:shrink_path fish yes
```
Note: Directory names containing two or more consecutive spaces are not yet
supported.
## License
Copyright (C) 2008 by Daniel Friesel <derf@xxxxxxxxxxxxxxxxxx>
Copyright (C) 2018-2020 by Pavel N. Krivitsky
License: WTFPL <http://www.wtfpl.net>
Ref: https://www.zsh.org/mla/workers/2009/msg00415.html
https://www.zsh.org/mla/workers/2009/msg00419.html
## Misc
Keywords: prompt directory truncate shrink collapse fish