mirror of
https://github.com/pcvolkmer/vim-fugistate.git
synced 2025-04-19 15:26:50 +00:00
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# vim-fugistate
|
|
|
|
## Usage
|
|
This simple plugin provides a function which returns the name of current file with git status if available using
|
|
[vim-fugitive](https://github.com/tpope/vim-fugitive) and is intended for statusline integration.
|
|
|
|
```vim
|
|
:echo FugiState()
|
|
```
|
|
|
|
It will show something like `main.c [ M]` for modified file `main.c`.
|
|
|
|
For example, to show the filename with git status using [lightline.vim](https://github.com/itchyny/lightline.vim),
|
|
configure as follows.
|
|
|
|
```vim
|
|
let g:lightline = {
|
|
\ 'active': {
|
|
\ 'left': [ [ 'mode', 'paste' ],
|
|
\ [ 'readonly', 'filenamestatus', 'modified' ] ]
|
|
\ },
|
|
\ 'component_function': {
|
|
\ 'filenamestatus': 'FugiState'
|
|
\ },
|
|
\ }
|
|
```
|
|
|
|
### Filename configuration
|
|
|
|
The plugin provides `g:fugistate_expand_filename` to modify the value the filename should be expanded to.
|
|
Default value is set to `'%:t'` and will show filename without path. Use available values like `'%:p'` for full path
|
|
or `''` to use `@%` for directory/filename relative to current working directory.
|
|
|
|
## License
|
|
This software is released under the MIT License, see LICENSE.
|