Removes old completion setup that breaks with current _git and _hub completions. Ruby is no longer required by hub; removes that test. Does not define new completions for hub; they are now defined by hub itself. Change the functions to use hub to create the repos on GitHub. Add error checking to the functions. Removes apparently-unused _github completion definition.master
parent
a9c882094d
commit
24492a2fdb
3 changed files with 87 additions and 100 deletions
@ -0,0 +1,46 @@ |
|||||||
|
# github |
||||||
|
|
||||||
|
This plugin supports working with GitHub the command line. It provides a few things: |
||||||
|
|
||||||
|
* Sets up the `hub` wrapper and completions for the `git` command if you have `hub` installed. |
||||||
|
* Completion for the `github` Ruby 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](http://git.io) |
||||||
|
|
||||||
|
|
||||||
|
## Installation |
||||||
|
|
||||||
|
[Hub](http://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](http://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 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 |
||||||
|
``` |
||||||
@ -1,40 +0,0 @@ |
|||||||
#compdef github |
|
||||||
#autoload |
|
||||||
|
|
||||||
# in order to make this work, you will need to have the github gem installed |
|
||||||
# http://github.com/defunkt/github-gem |
|
||||||
|
|
||||||
# github zsh completion, based on homebrew completion |
|
||||||
|
|
||||||
local -a _1st_arguments |
|
||||||
_1st_arguments=( |
|
||||||
'browse:Open this repo in a web browser' |
|
||||||
'clone:Clone a repo' |
|
||||||
'config:Automatically set configuration info, or pass args to specify' |
|
||||||
'create-from-local:Create a new GitHub repository from the current local repository' |
|
||||||
'create:Create a new empty GitHub repository' |
|
||||||
'fetch:Fetch from a remote to a local branch' |
|
||||||
'fetch_all:Fetch all refs from a user' |
|
||||||
'fork:Forks a GitHub repository' |
|
||||||
'home:Open this repos master branch in a web browser' |
|
||||||
'ignore:Ignore a SHA from github network commits' |
|
||||||
'info:Info about this project' |
|
||||||
'issues:Project issues tools' |
|
||||||
'network:Project network tools - sub-commands : web [user], list, fetch, commits' |
|
||||||
'open:Open the given user/project in a web browser' |
|
||||||
'pull-request:Generate the text for a pull request' |
|
||||||
'pull:Pull from a remote' |
|
||||||
'search:Search GitHub for the given repository name' |
|
||||||
'track:Track another users repository' |
|
||||||
) |
|
||||||
|
|
||||||
local expl |
|
||||||
local -a pkgs installed_pkgs |
|
||||||
|
|
||||||
_arguments \ |
|
||||||
'*:: :->subcmds' && return 0 |
|
||||||
|
|
||||||
if (( CURRENT == 1 )); then |
|
||||||
_describe -t commands "github subcommand" _1st_arguments |
|
||||||
return |
|
||||||
fi |
|
||||||
Loading…
Reference in new issue