A zero-configuration extension and improved version of the gf command in Vim,
which opens the file under the cursor, but now in a smarter way.
Install gfi.vim:
Using vim-pack:
git clone https://github.com/kkoomen/gfi.vim ~/.vim/pack/<dir>/start/gfi
Using pathogen:
git clone https://github.com/kkoomen/gfi.vim ~/.vim/bundle/gfi
Using plug:
Plug 'kkoomen/gfi.vim'
Files will be resolved now based on its path:
- relative to the current buffer
- relative to vim's current working directory
- based on the git directory it is located in
This is default behavior for every filetype.
Files will also be checked in a more advanced way per filetype when it can:
-
javascript / typescript / jsx
Most javascript projects these days use webpack to resolve their import statements. This module is also able to resolve these import paths, relative or absolute. Javascript-like filetype buffers will also try to resolve paths based on:
- The
moduleRootsproperty in thepackage.jsonof the project. - Whether the input is a directory and if it is, it will look for an
indexfile in that directory, since webpack is resolvingindexfiles if a directory is imported.
- The
-
golang
Go has an
importsyntax which contains paths relative to the$GOPATHvar.
For example:import ( "github.com/username/repo" "github.com/username/repo/src/dir/subdir" )These paths will be resolved using the format
$GOPATH/src/<import>.
default: 'edit'
Define the command which will open the file or directory.
For example: vsplit, split, tabnew, edit, etc...
Help or feedback is always appreciated. If you find any bugs or improvements, feel free to submit a pull request.
Your pull request should follow the rules of the vim-vint linter which is a
must to keep your code clean and prevent mistakes being made.
pip3 install vim-vint
If you use ALE (recommended)
let g:ale_linters = { 'vim': ['vint'] }
or if you use Syntastic
let g:syntastic_vim_checkers = ['vint']
Every function, mapping or configurable option should contain documentation. The
documentation in the doc/ should be generated using vimdoc.
Copyright 2019 Kim Koomen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent