Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kristijanhusak/defx-git
Git status implementation for https://github.com/Shougo/defx.nvim
https://github.com/kristijanhusak/defx-git
Last synced: 22 days ago
JSON representation
Git status implementation for https://github.com/Shougo/defx.nvim
- Host: GitHub
- URL: https://github.com/kristijanhusak/defx-git
- Owner: kristijanhusak
- License: mit
- Created: 2018-09-04T13:20:50.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T20:38:44.000Z (over 3 years ago)
- Last Synced: 2024-10-04T11:42:17.606Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 71
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# defx-git
Git status implementation for [defx.nvim](http://github.com/Shougo/defx.nvim).
## Usage
Just append `git` to your columns when starting defx:
```viml
:Defx -columns=git:mark:filename:type
```
## Options
### Indicators
Which indicators (icons) to use for each status. These are the defaults:
```viml
call defx#custom#column('git', 'indicators', {
\ 'Modified' : '✹',
\ 'Staged' : '✚',
\ 'Untracked' : '✭',
\ 'Renamed' : '➜',
\ 'Unmerged' : '═',
\ 'Ignored' : '☒',
\ 'Deleted' : '✖',
\ 'Unknown' : '?'
\ })
```
### Column Length
How many space should git column take. Default is `1` (Defx adds a single space between columns):
```viml
call defx#custom#column('git', 'column_length', 1)
```
Missing characters to match this length are populated with spaces, which means
`✹` becomes `✹ `, etc.
Note: Make sure indicators are not longer than the column_length
### Show ignored
This flag determines if ignored files should be marked with indicator. Default is `false`:
```viml
call defx#custom#column('git', 'show_ignored', 0)
```
### Raw Mode
Show git status in raw mode (Same as first two chars of `git status --porcelain` command). Default is `0`:
```viml
call defx#custom#column('git', 'raw_mode', 0)
```
### Change git commit
Change the git commit the files are diffed against (SHA-1, branchname, etc.). Default is `'HEAD'`:
```viml
call defx#custom#column('git', 'git_commit', 'HEAD')
```
### Max Indicator Width
The number of characters to pad the git column. If not specified, the default
will be the width of the longest indicator character.
```viml
call defx#custom#column('git', 'max_indicator_width', 2)
```
## Highlighting
Each indicator type can be overridden with the custom highlight. These are the defaults:
```viml
hi Defx_git_Untracked guibg=NONE guifg=NONE ctermbg=NONE ctermfg=NONE
hi Defx_git_Ignored guibg=NONE guifg=NONE ctermbg=NONE ctermfg=NONE
hi Defx_git_Unknown guibg=NONE guifg=NONE ctermbg=NONE ctermfg=NONE
hi Defx_git_Renamed ctermfg=214 guifg=#fabd2f
hi Defx_git_Modified ctermfg=214 guifg=#fabd2f
hi Defx_git_Unmerged ctermfg=167 guifg=#fb4934
hi Defx_git_Deleted ctermfg=167 guifg=#fb4934
hi Defx_git_Staged ctermfg=142 guifg=#b8bb26
```
To use for example red for untracked files, add this **after** your colorscheme setup:
```viml
colorscheme gruvbox
hi Defx_git_Untracked guifg=#FF0000
```
## Mappings
There are 5 mappings:
* `(defx-git-next)` - Goes to the next file that has a git status
* `(defx-git-prev)` - Goes to the previous file that has a git status
* `(defx-git-stage)` - Stages the file/directory under cursor
* `(defx-git-reset)` - Unstages the file/directory under cursor
* `(defx-git-discard)` - Discards all changes to file/directory under cursor
If these are not manually mapped by the user, defaults are:
```viml
nnoremap [c (defx-git-prev)
nnoremap ]c (defx-git-next)
nnoremap ]a (defx-git-stage)
nnoremap ]r (defx-git-reset)
nnoremap ]d (defx-git-discard)
```