diff options
Diffstat (limited to 'zsh/oh-my-zsh/plugins/github')
| -rw-r--r-- | zsh/oh-my-zsh/plugins/github/README.md | 46 | ||||
| -rw-r--r-- | zsh/oh-my-zsh/plugins/github/_hub | 174 | ||||
| -rw-r--r-- | zsh/oh-my-zsh/plugins/github/github.plugin.zsh | 76 |
3 files changed, 0 insertions, 296 deletions
diff --git a/zsh/oh-my-zsh/plugins/github/README.md b/zsh/oh-my-zsh/plugins/github/README.md deleted file mode 100644 index af2b8a4..0000000 --- a/zsh/oh-my-zsh/plugins/github/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# github plugin - -This plugin supports working with GitHub from the command line. It provides a few things: - -* Sets up the `hub` wrapper and completions for the `git` command if you have [`hub`](https://github.com/github/hub) installed. -* Completion for the [`github` Ruby gem](https://github.com/defunkt/github-gem). -* Convenience functions for working with repos and URLs. - -### Functions - -* `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub -* `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub -* `exist_gh` - Takes an existing repo and pushes it to GitHub -* `git.io` - Shortens a URL using [git.io](https://git.io) - - -## Installation - -[Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ. - -The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it. - -### Configuration - -These settings affect `github`'s behavior. - -#### Environment variables - -* `$GITHUB_USER` -* `$GITHUB_PASSWORD` - -#### Git configuration options - -* `github.user` - GitHub username for repo operations - -See `man hub` for more details. - -### Homebrew installation note - -If you have installed `hub` using Homebrew, its completions may not be on your `$FPATH` if you are using the system `zsh`. Homebrew installs `zsh` completion definitions to `/usr/local/share/zsh/site-functions`, which will be on `$FPATH` for the Homebrew-installed `zsh`, but not for the system `zsh`. If you want it to work with the system `zsh`, add this to your `~/.zshrc` before it sources `oh-my-zsh.sh`. - -```zsh -if (( ! ${fpath[(I)/usr/local/share/zsh/site-functions]} )); then - FPATH=/usr/local/share/zsh/site-functions:$FPATH -fi -``` diff --git a/zsh/oh-my-zsh/plugins/github/_hub b/zsh/oh-my-zsh/plugins/github/_hub deleted file mode 100644 index 209a3df..0000000 --- a/zsh/oh-my-zsh/plugins/github/_hub +++ /dev/null @@ -1,174 +0,0 @@ -#compdef hub - -# Zsh will source this file when attempting to autoload the "_hub" function, -# typically on the first attempt to complete the hub command. We define two new -# setup helper routines (one for the zsh-distributed version, one for the -# git-distributed, bash-based version). Then we redefine the "_hub" function to -# call "_git" after some other interception. -# -# This is pretty fragile, if you think about it. Any number of implementation -# changes in the "_git" scripts could cause problems down the road. It would be -# better if the stock git completions were just a bit more permissive about how -# it allowed third-party commands to be added. - -(( $+functions[__hub_setup_zsh_fns] )) || -__hub_setup_zsh_fns () { - (( $+functions[_git-alias] )) || - _git-alias () { - _arguments \ - '-s[output shell script suitable for eval]' \ - '1::shell:(zsh bash csh)' - } - - (( $+functions[_git-browse] )) || - _git-browse () { - _arguments \ - '-u[output the URL]' \ - '2::subpage:(wiki commits issues)' - } - - (( $+functions[_git-compare] )) || - _git-compare () { - _arguments \ - '-u[output the URL]' \ - ':[start...]end range:' - } - - (( $+functions[_git-create] )) || - _git-create () { - _arguments \ - '::name (REPOSITORY or ORGANIZATION/REPOSITORY):' \ - '-p[make repository private]' \ - '-d[description]:description' \ - '-h[home page]:repository home page URL:_urls' - } - - (( $+functions[_git-fork] )) || - _git-fork () { - _arguments \ - '--no-remote[do not add a remote for the new fork]' - } - - (( $+functions[_git-pull-request] )) || - _git-pull-request () { - _arguments \ - '-f[force (skip check for local commits)]' \ - '-b[base]:base ("branch", "owner\:branch", "owner/repo\:branch"):' \ - '-h[head]:head ("branch", "owner\:branch", "owner/repo\:branch"):' \ - - set1 \ - '-m[message]' \ - '-F[file]' \ - '--no-edit[use first commit message for pull request title/description]' \ - '-a[user]' \ - '-M[milestone]' \ - '-l[labels]' \ - - set2 \ - '-i[issue]:issue number:' \ - - set3 \ - '::issue-url:_urls' - } - - # stash the "real" command for later - functions[_hub_orig_git_commands]=$functions[_git_commands] - - # Replace it with our own wrapper. - declare -f _git_commands >& /dev/null && unfunction _git_commands - _git_commands () { - local ret=1 - # call the original routine - _call_function ret _hub_orig_git_commands - - # Effectively "append" our hub commands to the behavior of the original - # _git_commands function. Using this wrapper function approach ensures - # that we only offer the user the hub subcommands when the user is - # actually trying to complete subcommands. - hub_commands=( - alias:'show shell instructions for wrapping git' - pull-request:'open a pull request on GitHub' - pr:'list or checkout a GitHub pull request' - issue:'list or create a GitHub issue' - release:'list or create a GitHub release' - fork:'fork origin repo on GitHub' - create:'create new repo on GitHub for the current project' - delete:'delete a GitHub repo' - browse:'browse the project on GitHub' - compare:'open GitHub compare view' - ci-status:'show status of GitHub checks for a commit' - sync:'update local branches from upstream' - ) - _describe -t hub-commands 'hub command' hub_commands && ret=0 - - return ret - } -} - -(( $+functions[__hub_setup_bash_fns] )) || -__hub_setup_bash_fns () { - # TODO more bash-style fns needed here to complete subcommand args. They take - # the form "_git_CMD" where "CMD" is something like "pull-request". - - # Duplicate and rename the 'list_all_commands' function - eval "$(declare -f __git_list_all_commands | \ - sed 's/__git_list_all_commands/__git_list_all_commands_without_hub/')" - - # Wrap the 'list_all_commands' function with extra hub commands - __git_list_all_commands() { - cat <<-EOF -alias -pull-request -pr -issue -release -fork -create -delete -browse -compare -ci-status -sync -EOF - __git_list_all_commands_without_hub - } - - # Ensure cached commands are cleared - __git_all_commands="" -} - -# redefine _hub to a much smaller function in the steady state -_hub () { - # only attempt to intercept the normal "_git" helper functions once - (( $+__hub_func_replacement_done )) || - () { - # At this stage in the shell's execution the "_git" function has not yet - # been autoloaded, so the "_git_commands" or "__git_list_all_commands" - # functions will not be defined. Call it now (with a bogus no-op service - # to prevent premature completion) so that we can wrap them. - if declare -f _git >& /dev/null ; then - _hub_noop () { __hub_zsh_provided=1 } # zsh-provided will call this one - __hub_noop_main () { __hub_git_provided=1 } # git-provided will call this one - local service=hub_noop - _git - unfunction _hub_noop - unfunction __hub_noop_main - service=git - fi - - if (( $__hub_zsh_provided )) ; then - __hub_setup_zsh_fns - elif (( $__hub_git_provided )) ; then - __hub_setup_bash_fns - fi - - __hub_func_replacement_done=1 - } - - # Now perform the actual completion, allowing the "_git" function to call our - # replacement "_git_commands" function as needed. Both versions expect - # service=git or they will call nonexistent routines or end up in an infinite - # loop. - service=git - declare -f _git >& /dev/null && _git -} - -# make sure we actually attempt to complete on the first "tab" from the user -_hub diff --git a/zsh/oh-my-zsh/plugins/github/github.plugin.zsh b/zsh/oh-my-zsh/plugins/github/github.plugin.zsh deleted file mode 100644 index 8e4b973..0000000 --- a/zsh/oh-my-zsh/plugins/github/github.plugin.zsh +++ /dev/null @@ -1,76 +0,0 @@ -# Set up hub wrapper for git, if it is available; https://github.com/github/hub -if (( $+commands[hub] )); then - alias git=hub -fi - -# Functions ################################################################# - -# Based on https://github.com/dbb/githome/blob/master/.config/zsh/functions - -# empty_gh <NAME_OF_REPO> -# -# Use this when creating a new repo from scratch. -# Creates a new repo with a blank README.md in it and pushes it up to GitHub. -empty_gh() { # [NAME_OF_REPO] - emulate -L zsh - local repo=$1 - - mkdir "$repo" - touch "$repo/README.md" - new_gh "$repo" -} - -# new_gh [DIRECTORY] -# -# Use this when you have a directory that is not yet set up for git. -# This function will add all non-hidden files to git. -new_gh() { # [DIRECTORY] - emulate -L zsh - local repo="$1" - cd "$repo" \ - || return - - git init \ - || return - # add all non-dot files - print '.*'"\n"'*~' >> .gitignore - git add [^.]* \ - || return - git add -f .gitignore \ - || return - git commit -m 'Initial commit.' \ - || return - hub create \ - || return - git push -u origin master \ - || return -} - -# exist_gh [DIRECTORY] -# -# Use this when you have a git repo that's ready to go and you want to add it -# to your GitHub. -exist_gh() { # [DIRECTORY] - emulate -L zsh - local repo=$1 - cd "$repo" - - hub create \ - || return - git push -u origin master -} - -# git.io "GitHub URL" -# -# Shorten GitHub url, example: -# https://github.com/nvogel/dotzsh > https://git.io/8nU25w -# source: https://github.com/nvogel/dotzsh -# documentation: https://github.com/blog/985-git-io-github-url-shortener -# -git.io() { - emulate -L zsh - curl -i -s https://git.io -F "url=$1" | grep "Location" | cut -f 2 -d " " -} - -# End Functions ############################################################# - |