mirror of https://github.com/ohmyzsh/ohmyzsh.git
Compare commits
4 Commits
b5679bff75
...
9245a7c82f
Author | SHA1 | Date |
---|---|---|
|
9245a7c82f | |
|
30e516a3aa | |
|
c99a1c5fb5 | |
|
a86e5876eb |
|
@ -0,0 +1,23 @@
|
||||||
|
# CircleCi Plugin
|
||||||
|
|
||||||
|
This plugin provides easy to use cli commands to query circle ci job statuses
|
||||||
|
|
||||||
|
To use it, add `circleci` to the plugins array in your zshrc file:
|
||||||
|
|
||||||
|
```zsh
|
||||||
|
plugins=(... circleci)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
You need to have the `CIRCLECI_API_TOKEN` and `CIRCLECI_ORG_SLUG` as environment
|
||||||
|
variables before calling the `circleci_status` function <br>
|
||||||
|
You can learn how to add a circleci api token [here](https://circleci.com/docs/managing-api-tokens/) <br>
|
||||||
|
The org slug takes the format of `{vcs}/{org_name}`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```shell
|
||||||
|
> circleci_status
|
||||||
|
```
|
||||||
|
The above command would list down all the jobs (with their run status) on the
|
||||||
|
repository and branch that you are currently on <br>
|
||||||
|
You can also use the `cis` alias to run the above function
|
|
@ -0,0 +1,12 @@
|
||||||
|
# Handle $0 according to the standard:
|
||||||
|
# https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html
|
||||||
|
0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}"
|
||||||
|
0="${${(M)0:#/*}:-$PWD/$0}"
|
||||||
|
__CI_ZSH_DIR="${0:h:A}"
|
||||||
|
|
||||||
|
alias cis='circleci_status'
|
||||||
|
|
||||||
|
|
||||||
|
function circleci_status() {
|
||||||
|
python3 "$__CI_ZSH_DIR"/circleci_status.py "$(git_current_branch)" "$(git_repo_name)" | less
|
||||||
|
}
|
|
@ -0,0 +1,73 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
CIRCLECI_API = "https://circleci.com/api/v2"
|
||||||
|
org_slug = os.environ.get("CIRCLECI_ORG_SLUG")
|
||||||
|
args = sys.argv
|
||||||
|
|
||||||
|
|
||||||
|
class COLORS:
|
||||||
|
reset = '\033[0m'
|
||||||
|
|
||||||
|
class FG:
|
||||||
|
red = '\033[31m'
|
||||||
|
green = '\033[32m'
|
||||||
|
yellow = '\033[93m'
|
||||||
|
|
||||||
|
|
||||||
|
def get_resp_items(resp):
|
||||||
|
if resp.status_code != 200:
|
||||||
|
sys.exit(0)
|
||||||
|
items = resp.json()["items"]
|
||||||
|
if len(items) == 0:
|
||||||
|
sys.exit(0)
|
||||||
|
return items
|
||||||
|
|
||||||
|
|
||||||
|
def get_status_text(status):
|
||||||
|
if status == "success":
|
||||||
|
return COLORS.FG.green + "✓" + COLORS.reset
|
||||||
|
elif status in ("running", "not_run", "retried"):
|
||||||
|
return COLORS.FG.yellow + "•" + COLORS.reset
|
||||||
|
else:
|
||||||
|
return COLORS.FG.red + "✗" + COLORS.reset
|
||||||
|
|
||||||
|
|
||||||
|
if not org_slug or len(args) != 3:
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
branch_name = args[1]
|
||||||
|
repo_name = args[2]
|
||||||
|
|
||||||
|
# Here we query for all the pipelines belonging to the current branch in the current repo
|
||||||
|
headers = {"Circle-token": os.environ.get("CIRCLECI_API_TOKEN")}
|
||||||
|
url = f"{CIRCLECI_API}/project/{org_slug}/{repo_name}/pipeline"
|
||||||
|
params = {"branch": branch_name}
|
||||||
|
response = requests.get(url, headers=headers, params=params)
|
||||||
|
pipelines = get_resp_items(response)
|
||||||
|
# use the latest pipeline
|
||||||
|
pipeline_id = pipelines[0]["id"]
|
||||||
|
|
||||||
|
# Now fetch the workflows for the selected pipeline
|
||||||
|
url = f"{CIRCLECI_API}/pipeline/{pipeline_id}/workflow"
|
||||||
|
response = requests.get(url, headers=headers)
|
||||||
|
workflows = get_resp_items(response)
|
||||||
|
# use the latest workflow
|
||||||
|
workflow_id = workflows[0]["id"]
|
||||||
|
|
||||||
|
url = f"{CIRCLECI_API}/workflow/{workflow_id}/job"
|
||||||
|
response = requests.get(url, headers=headers)
|
||||||
|
jobs = get_resp_items(response)
|
||||||
|
|
||||||
|
for job in jobs:
|
||||||
|
status = job["status"]
|
||||||
|
if status in ("success", "running", "failed", "retried", "timedout",
|
||||||
|
"on_hold", "canceled", "terminated_unknown"):
|
||||||
|
name = job["name"]
|
||||||
|
project_slug = job["project_slug"]
|
||||||
|
job_number = job["job_number"]
|
||||||
|
url = f"https://circleci.com/{project_slug}/{job_number}"
|
||||||
|
print("{} {:<50} {}".format(get_status_text(status), name, url))
|
|
@ -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'
|
Loading…
Reference in New Issue