mirror of https://github.com/ohmyzsh/ohmyzsh.git
Compare commits
3 Commits
d1c0086f4f
...
38c964abab
Author | SHA1 | Date |
---|---|---|
|
38c964abab | |
|
30e516a3aa | |
|
66ac7ff0c2 |
|
@ -0,0 +1,89 @@
|
||||||
|
# jj - Jujutsu CLI
|
||||||
|
|
||||||
|
This plugin provides autocompletion for [jj](https://martinvonz.github.io/jj).
|
||||||
|
|
||||||
|
To use it, add `jj` to the plugins array of your zshrc file:
|
||||||
|
|
||||||
|
```zsh
|
||||||
|
plugins=(... jj)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Aliases
|
||||||
|
|
||||||
|
| Alias | Command |
|
||||||
|
| ------ | ----------------------------- |
|
||||||
|
| jjc | `jj commit` |
|
||||||
|
| jjcmsg | `jj commit --message` |
|
||||||
|
| jjd | `jj diff` |
|
||||||
|
| jjdmsg | `jj desc --message` |
|
||||||
|
| jjds | `jj desc` |
|
||||||
|
| jje | `jj edit` |
|
||||||
|
| jjgcl | `jj git clone` |
|
||||||
|
| jjgf | `jj git fetch` |
|
||||||
|
| jjgp | `jj git push` |
|
||||||
|
| jjl | `jj log` |
|
||||||
|
| jjla | `jj log -r "all()"` |
|
||||||
|
| jjn | `jj new` |
|
||||||
|
| jjrb | `jj rebase` |
|
||||||
|
| jjrs | `jj restore` |
|
||||||
|
| jjrt | `cd "$(jj root \|\| echo .)"` |
|
||||||
|
| jjsp | `jj split` |
|
||||||
|
| jjsq | `jj squash` |
|
||||||
|
|
||||||
|
## Prompt usage
|
||||||
|
|
||||||
|
Because `jj` has a very powerful [template syntax](https://martinvonz.github.io/jj/latest/templates/), this
|
||||||
|
plugin only exposes a convenience function `jj_prompt_template` to read information from the current change.
|
||||||
|
It is basically the same as `jj log --no-graph -r @ -T $1`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
_my_theme_jj_info() {
|
||||||
|
jj_prompt_template 'self.change_id().shortest(3)'
|
||||||
|
}
|
||||||
|
|
||||||
|
PROMPT='$(_my_theme_jj_info) $'
|
||||||
|
```
|
||||||
|
|
||||||
|
`jj_prompt_template` escapes `%` signs in the output. Use `jj_prompt_template_raw` if you don't want that
|
||||||
|
(e.g. to colorize the output).
|
||||||
|
|
||||||
|
However, because `jj` can be used inside a Git repository, some themes might clash with it. Generally, you can
|
||||||
|
fix it with a wrapper function that tries `jj` first and then falls back to `git` if it didn't work:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
_my_theme_vcs_info() {
|
||||||
|
jj_prompt_template 'self.change_id().shortest(3)' \
|
||||||
|
|| git_prompt_info
|
||||||
|
}
|
||||||
|
|
||||||
|
PROMPT='$(_my_theme_vcs_info) $'
|
||||||
|
```
|
||||||
|
|
||||||
|
You can find an example
|
||||||
|
[here](https://github.com/nasso/omzsh/blob/e439e494f22f4fd4ef1b6cb64626255f4b341c1b/themes/sunakayu.zsh-theme).
|
||||||
|
|
||||||
|
### Performance
|
||||||
|
|
||||||
|
Sometimes `jj` can be slower than `git`.
|
||||||
|
|
||||||
|
If you feel slowdowns, consider using the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
zstyle :omz:plugins:jj ignore-working-copy yes
|
||||||
|
```
|
||||||
|
|
||||||
|
This will add `--ignore-working-copy` to all `jj` commands executed by your prompt. The downside here is that
|
||||||
|
your prompt might be out-of-sync until the next time `jj` gets a chance to _not_ ignore the working copy (i.e.
|
||||||
|
you manually run a `jj` command).
|
||||||
|
|
||||||
|
If you prefer to keep your prompt always up-to-date but still don't want to _feel_ the slowdown, you can make
|
||||||
|
your prompt asynchronous. This plugin doesn't do this automatically so you'd have to hack your theme a bit for
|
||||||
|
that.
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- [martinvonz/jj](https://github.com/martinvonz/jj)
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
- [nasso](https://github.com/nasso) - Plugin Author
|
|
@ -0,0 +1,53 @@
|
||||||
|
# if jj is not found, don't do the rest of the script
|
||||||
|
if (( ! $+commands[jj] )); then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If the completion file doesn't exist yet, we need to autoload it and
|
||||||
|
# bind it to `jj`. Otherwise, compinit will have already done that.
|
||||||
|
if [[ ! -f "$ZSH_CACHE_DIR/completions/_jj" ]]; then
|
||||||
|
typeset -g -A _comps
|
||||||
|
autoload -Uz _jj
|
||||||
|
_comps[jj]=_jj
|
||||||
|
fi
|
||||||
|
|
||||||
|
jj util completion zsh >| "$ZSH_CACHE_DIR/completions/_jj" &|
|
||||||
|
|
||||||
|
function __jj_prompt_jj() {
|
||||||
|
local -a flags
|
||||||
|
flags=("--no-pager")
|
||||||
|
if zstyle -t ':omz:plugins:jj' ignore-working-copy; then
|
||||||
|
flags+=("--ignore-working-copy")
|
||||||
|
fi
|
||||||
|
command jj $flags "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
# convenience functions for themes
|
||||||
|
function jj_prompt_template_raw() {
|
||||||
|
__jj_prompt_jj log --no-graph -r @ -T "$@" 2> /dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
function jj_prompt_template() {
|
||||||
|
local out
|
||||||
|
out=$(jj_prompt_template_raw "$@") || return 1
|
||||||
|
echo "${out:gs/%/%%}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Aliases (sorted alphabetically)
|
||||||
|
alias jjc='jj commit'
|
||||||
|
alias jjcmsg='jj commit --message'
|
||||||
|
alias jjd='jj diff'
|
||||||
|
alias jjdmsg='jj desc --message'
|
||||||
|
alias jjds='jj desc'
|
||||||
|
alias jje='jj edit'
|
||||||
|
alias jjgcl='jj git clone'
|
||||||
|
alias jjgf='jj git fetch'
|
||||||
|
alias jjgp='jj git push'
|
||||||
|
alias jjl='jj log'
|
||||||
|
alias jjla='jj log -r "all()"'
|
||||||
|
alias jjn='jj new'
|
||||||
|
alias jjrb='jj rebase'
|
||||||
|
alias jjrs='jj restore'
|
||||||
|
alias jjrt='cd "$(jj root || echo .)"'
|
||||||
|
alias jjsp='jj split'
|
||||||
|
alias jjsq='jj squash'
|
|
@ -1,15 +1,25 @@
|
||||||
# node plugin
|
# node plugin
|
||||||
|
|
||||||
This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
|
This plugin provides many a aliases and a few `node-docs` functions.
|
||||||
documentation (depending on the installed version).
|
|
||||||
|
|
||||||
To use it, add `node` to the plugins array of your zshrc file:
|
## Aliases
|
||||||
|
|
||||||
```zsh
|
| Alias | Command |
|
||||||
plugins=(... node)
|
|:---------------------|:-------------------------------------------------------------------------------|
|
||||||
```
|
| nd | node |
|
||||||
|
| ndc | node --check |
|
||||||
|
| nde | node --eval "script" |
|
||||||
|
| ndh | node --help |
|
||||||
|
| ndi | git --interactive |
|
||||||
|
| ndr | git --require module |
|
||||||
|
|----------------------|--------------------------------------------------------------------------------|
|
||||||
|
| ndnd | node --no-depreciation |
|
||||||
|
| ndnw | node --no-warnings |
|
||||||
|
| ndtw | node --trace-warnings |
|
||||||
|
| ndv8 | node --V8-options |
|
||||||
|
|----------------------|--------------------------------------------------------------------------------|
|
||||||
|
|
||||||
## Usage
|
## Functions
|
||||||
|
|
||||||
```zsh
|
```zsh
|
||||||
# Opens https://nodejs.org/docs/latest-v10.x/api/fs.html
|
# Opens https://nodejs.org/docs/latest-v10.x/api/fs.html
|
||||||
|
@ -17,3 +27,13 @@ $ node-docs fs
|
||||||
# Opens https://nodejs.org/docs/latest-v10.x/api/path.html
|
# Opens https://nodejs.org/docs/latest-v10.x/api/path.html
|
||||||
$ node-docs path
|
$ node-docs path
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
|
||||||
|
documentation (depending on the installed version).
|
||||||
|
|
||||||
|
## Add plugin
|
||||||
|
To use it, add `node` to the plugins array of your zshrc file:
|
||||||
|
|
||||||
|
```zsh
|
||||||
|
plugins=(... node)
|
||||||
|
```
|
|
@ -4,3 +4,20 @@ function node-docs {
|
||||||
local section=${1:-all}
|
local section=${1:-all}
|
||||||
open_command "https://nodejs.org/docs/$(node --version)/api/$section.html"
|
open_command "https://nodejs.org/docs/$(node --version)/api/$section.html"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# initialise node
|
||||||
|
alias nd='node'
|
||||||
|
|
||||||
|
# Checkout the README.md for
|
||||||
|
# detailed explanation
|
||||||
|
alias ndv='node --version'
|
||||||
|
alias ndc='node -c'
|
||||||
|
alias nde='node -e'
|
||||||
|
alias ndh='node -h'
|
||||||
|
alias ndi='node -i'
|
||||||
|
alias ndr='node -r'
|
||||||
|
|
||||||
|
alias ndnd='node --no-depreciation'
|
||||||
|
alias ndnw='node --no-warnings'
|
||||||
|
alias ndtw='node --trace-warnings'
|
||||||
|
alias ndv8='node --V8-options'
|
Loading…
Reference in New Issue