Skip to content

Commit

Permalink
git layer: Improve git-link support and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
syl20bnr committed Apr 12, 2015
1 parent 610eedd commit 9f94f4d
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 22 deletions.
33 changes: 15 additions & 18 deletions contrib/git/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
- [Github support](#github-support)
- [magit-gh-pulls](#magit-gh-pulls)
- [gist.el](#gistel)
- [github-browse-file](#github-browse-file)
- [git-link](#git-link)
- [Browse files](#browse-files)

<!-- markdown-toc end -->

Expand All @@ -45,6 +44,8 @@ Features:
This layer also provides support for Github with:
- [magit-gh-pulls][]: handy `magit` add-on to manage Github pull requests.
- [gist.el][]: full-featured mode to browse and post Githug gists.
- [github-browse-file][] and [git-link][]: quickly browse github URL in your
browser.

New to Magit? Checkout the [official intro][].

Expand Down Expand Up @@ -341,28 +342,22 @@ In the gist list buffer:
<kbd>V</kbd> | `visual-line state`
<kbd>y</kbd> | print URL and copy it

### github-browse-file
### Browse files

Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC g f b</kbd> | browse to file on github

### git-link

Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC g f l</kbd> | browse to file on github/bitbucket/etc (on current line possition)
<kbd>SPC g f c</kbd> | browse to file on github/bitbucket/etc (on current line at commit)
<kbd>SPC g f C</kbd> | only copy the generated link on the kill ring
<kbd>SPC g f l</kbd> | browse to file on github/bitbucket/etc (on current line position)
<kbd>SPC g f L</kbd> | only copy the generated link on the kill ring

Pro Tip: if you have multiple remotes, try prepending `SPC u` to the calls to the git-link

Pro Tip #2: You can select a region and use git-link to have the whole region selected in the link

Pro tip #3: The link is openned automatically, but it's copied to the clipboard
too if you don't want for any reason to have the link opened all the time, put this on your `dotspacemacs/config`:
```elisp
(setq git-link-open-in-browser nil)
```
**Notes**
- You can use the universal argument `SPC u` to select a remote repository.
- You can use `git-link` on a region.
- When the link is opened, the URL is also copied in the kill ring, you can
override this behavior by setting the variable `git-link-open-in-browser` to
`nil`.

[git]: http://git-scm.com/
[download page]: http://git-scm.com/downloads
Expand All @@ -376,3 +371,5 @@ too if you don't want for any reason to have the link opened all the time, put t
[git-messenger]: https://github.com/syohex/emacs-git-messenger
[magit-gh-pulls]: https://github.com/sigma/magit-gh-pulls
[gist.el]: https://github.com/defunkt/gist.el
[git-link]: https://github.com/sshaw/git-link
[github-browse-file]: https://github.com/osener/github-browse-file
27 changes: 23 additions & 4 deletions contrib/git/packages.el
Original file line number Diff line number Diff line change
Expand Up @@ -325,11 +325,30 @@ which require an initialization must be listed explicitly in the list.")

(defun git/init-git-link ()
(use-package git-link
:if git-enable-github-support
:defer t
:init
(evil-leader/set-key
"gfl" 'git-link
"gfc" 'git-link-commit)
(setq git-link-open-in-browser t)))
(progn

(defun spacemacs/git-link-copy-url-only ()
"Only copy the generated link to the kill ring."
(interactive)
(let (git-link-open-in-browser)
(call-interactively 'git-link)))

(defun spacemacs/git-link-commit-copy-url-only ()
"Only copy the generated link to the kill ring."
(interactive)
(let (git-link-open-in-browser)
(call-interactively 'git-link-commit)))

(evil-leader/set-key
"gfl" 'git-link
"gfL" 'spacemacs/git-link-copy-url-only
"gfc" 'git-link-commit
"gfC" 'spacemacs/git-link-commit-copy-url-only)
;; default is to open the generated link
(setq git-link-open-in-browser t))))

(defun git/init-magit-gitflow ()
(use-package magit-gitflow
Expand Down

0 comments on commit 9f94f4d

Please sign in to comment.