https://github.com/arnested/bug-reference-github

Automatically set `bug-reference-url-format' and enable `bug-reference-prog-mode' in Emacs buffers from Github repositories.
https://github.com/arnested/bug-reference-github

emacs hacktoberfest

Last synced: 3 months ago
JSON representation

Automatically set `bug-reference-url-format' and enable `bug-reference-prog-mode' in Emacs buffers from Github repositories.

• Host: GitHub
• URL: https://github.com/arnested/bug-reference-github
• Owner: arnested
• License: gpl-3.0
• Created: 2012-10-31T06:40:29.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-02-06T22:02:01.000Z (about 5 years ago)
• Last Synced: 2023-03-12T02:48:28.276Z (almost 2 years ago)
• Topics: emacs, hacktoberfest
• Language: Emacs Lisp
• Homepage: https://melpa.org/#/bug-reference-github
• Size: 31.3 KB
• Stars: 15
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# bug-reference-github

Automatically set `bug-reference-url-format` and enable

`bug-reference-prog-mode` buffers from Github repositories.

What it does is: 

1. If `bug-reference-url-format` is not set and this appears to be

    part of a git working copy (we can locate a .git/config).

2. Find the git remote repository (run `git ls-remote --get-url`).

3. If the remote matches github.com set `bug-reference-url-format` to

    the correct Github issue URL (we set it buffer locally).

4. Enable `bug-reference-prog-mode`.

## Installation and usage

The easiest way to install bug-reference-github is probably to install

it via the ELPA archive from

[MELPA](http://melpa.milkbox.net/#/bug-reference-github).

If you don't install via ELPA make sure that bug-reference-github.el is in

your load-path and require the library

    (add-to-list 'load-path "~/.emacs.d/path/to/bug-reference-github")

    (require 'bug-reference-github)

Then, to use `bug-reference-github` in every opened file:

    (add-hook 'find-file-hook 'bug-reference-github-set-url-format)

Alternatively, you can use `prog-mode-hook`:

    (add-hook 'prog-mode-hook 'bug-reference-github-set-url-format)

## Requirements

bug-reference-github depends on bug-reference.el which is part of

Emacs 23 and greater.

## Development of bug-reference-github

bug-reference-github.el is developed at

[GitHub](https://github.com/arnested/bug-reference-github).  Feature

requests, ideas, bug reports, and pull request are more that welcome!