https://github.com/moznion/github-commit-comment.vim

Vim Plugin for Commit Comment of GitHub
https://github.com/moznion/github-commit-comment.vim

Last synced: about 1 year ago
JSON representation

Vim Plugin for Commit Comment of GitHub

• Host: GitHub
• URL: https://github.com/moznion/github-commit-comment.vim
• Owner: moznion
• Created: 2014-04-27T10:05:22.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2014-11-26T02:00:49.000Z (over 11 years ago)
• Last Synced: 2025-04-11T18:03:27.330Z (about 1 year ago)
• Language: VimL
• Size: 191 KB
• Stars: 38
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# github-commit-comment.vim

Post and show GitHub commit comment on vim

## Description

This plugin supports the following features;

- Post commit comment by vim

    - Line comment

    - Commit comment

    - File comment

- Show commit line comment on vim

These command work on last modified git revision of editing file and `origin` of remote.

## Commands

### GitHubLineComment [comment]

Posts commit line comment to last modified revision of editing file and current cursored line.

#### Without command argument

![commit line comment](https://dl.dropboxusercontent.com/u/14832699/github-commit-comment-vim/line_comment.gif)

#### With command argument

![commit line comment with argument](https://dl.dropboxusercontent.com/u/14832699/github-commit-comment-vim/line_comment2.gif)

### GitHubCommitComment [comment]

Posts commit comment to last modified revision of editing file.

![commit comment](https://dl.dropboxusercontent.com/u/14832699/github-commit-comment-vim/commit_comment.gif)

### GitHubFileComment [comment]

Posts commit file comment to last modified revision of editing file and current file.

![commit file comment](https://dl.dropboxusercontent.com/u/14832699/github-commit-comment-vim/file_comment.gif)

### GitHubFetchCommitComment

Fetch commit comments and show line comments on Vim (insert into quickfix)

![fetch commit comments](https://dl.dropboxusercontent.com/u/14832699/github-commit-comment-vim/fetch.gif)

## Configurations

### Authentication (requires)

1. Generate access token of GitHub at "Personal access tokens" ([https://github.com/settings/applications](https://github.com/settings/applications)). This plugin only requires `repo` permission.

2. Please put `.github_commit_comment.vim` file on your home directory. And fill github access token into this file. For example;

```vim

let g:github_commit_comment_vim = {'token': '__YOUR_ACCESS_TOKEN__'}

```

### Specify API Endpoint (optional)

Fill URL of API endpoint in `.github_commit_comment.vim`, like so;

```vim

let g:github_commit_comment_vim = {'api_endpoint': 'http://example.com/api/v3'}

```

Default API endpoint is "https://api.github.com". If you don't specify `api_endpoint`, this plugin use the default URL.

### Sample of configuration file

```vim

let g:github_commit_comment_vim = {

      \ 'token': '__YOUR_ACCESS_TOKEN__',

      \ 'api_endpoint': 'http://example.com/api/v3'

\ }

```

## Dependencies

### Requires

- [webapi-vim](https://github.com/mattn/webapi-vim])

### Recommends

- [vim-hier](https://github.com/jceb/vim-hier)

- [quickfixstatus](https://github.com/dannyob/quickfixstatus)

## License

MIT