Comparing version 1.0.2 to 1.1.0
{ | ||
"name": "git-open", | ||
"version": "1.0.2", | ||
"description": "Type `git open` to open the GitHub page or website for a repository.", | ||
"version": "1.1.0", | ||
"description": "Type `git open` to open the GitHub/GitLab/Bitbucket homepage for a repository.", | ||
"author": "Paul Irish (http://paulirish.com/)", | ||
"license": "MIT", | ||
"homepage": "https://github.com/paulirish/git-open", | ||
"bugs": { | ||
"url": "https://github.com/paulirish/git-open/issues" | ||
}, | ||
"repository": { | ||
@@ -9,2 +15,7 @@ "type": "git", | ||
}, | ||
"contributors": [ | ||
"Paul Irish (http://paulirish.com/)", | ||
"Jason McCreary <jason@pureconcepts.net> (http://jason.pureconcepts.net/)", | ||
"David O'Trakoun <me@davidosomething.com> (https://davidosomething.com/)" | ||
], | ||
"keywords": [ | ||
@@ -14,11 +25,21 @@ "git", | ||
], | ||
"engines": { | ||
"node": ">=0.10.3", | ||
"npm": ">=2.0.0" | ||
}, | ||
"preferGlobal": true, | ||
"bin": { | ||
"git-open": "git-open" | ||
"git-open": "git-open", | ||
"git-home": "git-open" | ||
}, | ||
"author": "Paul Irish", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/paulirish/git-open/issues" | ||
"scripts": { | ||
"lint:package": "echo \"\nLinting package.json\" && pjv --recommendations --warnings && echo \"OK\n\n\"", | ||
"lint:readme": "echo \"\nLinting README.md\" && markdownlint --config markdownlint.json README.md && echo \"OK\n\n\"", | ||
"test": "npm run --silent lint:package && npm run --silent lint:readme" | ||
}, | ||
"homepage": "https://github.com/paulirish/git-open" | ||
} | ||
"dependencies": {}, | ||
"devDependencies": { | ||
"markdownlint": "^0.2.0", | ||
"package-json-validator": "^0.6.1" | ||
} | ||
} |
110
README.md
# git-open | ||
Type `git open` to open the GitHub page or website for a repository in your browser. | ||
Type `git open` to open the GitHub page or website for a repository in your | ||
browser. | ||
## Usage | ||
git open [remote-name] [branch-name] | ||
![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif) | ||
### Examples | ||
### Examples | ||
$ git open | ||
@@ -20,37 +21,98 @@ > open https://github.com/REMOTE_ORIGIN_USER/CURRENT_REPO/tree/CURRENT_BRANCH | ||
![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif) | ||
## Installation | ||
### Installation | ||
#### Without using a framework | ||
```sh | ||
npm install --global git-open | ||
``` | ||
The preferred way of installation is to simply add the `git-open` script | ||
somewhere into your path (e.g. add the directory to your `PATH` environment | ||
or copy `git-open` into an existing included path like `/usr/local/bin`). | ||
You can use also `npm` to install an OLD (1 year ago) version of this package: | ||
#### Supported: | ||
* Github.com | ||
* Gists on Github | ||
* Bitbucket | ||
* Atlassian Stash | ||
* Gitlab.com | ||
* Gitlab custom hosted (see below) | ||
npm install --global git-open | ||
#### Using a ZSH Framework | ||
## Gitlab support | ||
To configure gitlab support you need to set gitopen.gitlab.domain: | ||
##### [Antigen](https://github.com/zsh-users/antigen) | ||
``` | ||
git config --global gitopen.gitlab.domain [yourdomain.here] | ||
# or | ||
git config gitopen.gitlab.domain [yourdomain.here] # in your local repository | ||
``` | ||
Add `antigen bundle paulirish/git-open` to your `.zshrc` with your other bundle | ||
commands. | ||
Antigen will handle cloning the plugin for you automatically the next time you | ||
start zsh, and periodically checking for updates to the git repository. You can | ||
also add the plugin to a running zsh with `antigen bundle paulirish/git-open` | ||
for testing before adding it to your `.zshrc`. | ||
## Thx | ||
@jasonmccreary did [all the hard work](https://github.com/jasonmccreary/gh) | ||
##### [Oh-My-Zsh](http://ohmyz.sh/) | ||
1. `cd ~/.oh-my-zsh/custom/plugins` | ||
1. `git clone git@github.com:paulirish/git-open.git gitopen` | ||
1. Add git-open to your plugin list - edit `~/.zshrc` and change | ||
`plugins=(...)` to `plugins=(... gitopen)` | ||
##### [Zgen](https://github.com/tarjoilija/zgen) | ||
Add `zgen load paulirish/git-open` to your .zshrc file in the same function | ||
you're doing your other `zgen load` calls in. ZGen will take care of cloning | ||
the repository the next time you run `zgen save`, and will also periodically | ||
check for updates to the git repository. | ||
##### [zplug](https://github.com/zplug/zplug) | ||
`zplug "paulirish/git-open", as:command` | ||
### Supported remote repositories | ||
git-open can automatically guess the corresponding repository page for remotes | ||
(default looks for `origin`) on the following hosts: | ||
- github.com | ||
- gist.github.com | ||
- gitlab.com | ||
- Gitlab custom hosted (see below) | ||
- bitbucket.org | ||
- Atlassian Bitbucket Server (formerly _Atlassian Stash_) | ||
#### Gitlab support | ||
To configure gitlab support globally you need to set `gitopen.gitlab.domain` | ||
git config --global gitopen.gitlab.domain [yourdomain.here] | ||
or in your local repository: | ||
git config gitopen.gitlab.domain [yourdomain.here] | ||
## Related projects / alternatives | ||
See [hub](https://github.com/github/hub) for complete GitHub opening support. | ||
It's the official GitHub project and provides `hub browse`. | ||
Homebrew has an alternate [git-open](https://github.com/jeffreyiacono/git-open) | ||
that only works with GitHub but can open user profile pages, too. | ||
## Thanks | ||
[jasonmccreary](https://github.com/jasonmccreary/) did | ||
[all the hard work](https://github.com/jasonmccreary/gh) | ||
See the contributors tab for a growing list of people who have submitted PRs. | ||
## Contributing | ||
Please provide examples of the URLs you are parsing with each PR. | ||
## License | ||
Copyright Jason McCreary & Paul Irish. Licensed under MIT. | ||
<http://opensource.org/licenses/MIT> | ||
http://opensource.org/licenses/MIT | ||
## Changelog | ||
- **2016-07-22** - 1.1.0, update and add linters for package.json, readme. | ||
Re-publish to NPM. | ||
- **2016-07-11** - Changelog started (readme formatting and installation | ||
instructions updated) | ||
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
8235
6
14
118
2