https://github.com/flatcap/vim-local
⚙ Vim Plugin - Project-wide vim scripts
https://github.com/flatcap/vim-local
local plugin script vim vimrc
Last synced: 3 months ago
JSON representation
⚙ Vim Plugin - Project-wide vim scripts
- Host: GitHub
- URL: https://github.com/flatcap/vim-local
- Owner: flatcap
- License: other
- Created: 2015-05-03T22:53:53.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2022-06-12T19:25:17.000Z (over 3 years ago)
- Last Synced: 2025-01-19T09:32:02.624Z (about 1 year ago)
- Topics: local, plugin, script, vim, vimrc
- Language: Vim script
- Homepage:
- Size: 19.5 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# local.vim
## VimLocal runs scripts in local directories
Think of VimLocal as project-wide vim settings.
When run, VimLocal reads the `.vimlocal` file in the same directory as the file
you're editing. Next it looks in the parent directory, then the grand-parent
directory and so on. VimLocal stops when it reaches your home directory.
For safety, VimLocal will not run any scripts outside your home directory (as
defined by the environment variable $HOME).
## Running VimLocal
By default, VimLocal will not run. To enable it, create a mapping or
autocommand. e.g.
nmap LoadVimLocal
autocmd BufNewFile,BufRead * call LoadVimLocal()
## Configuration
VimLocal is configured by global variables:
The filename to read:
let g:vimlocal_file = '.vimlocal'
The number of directories to descend:
let g:vimlocal_max_depth = 50
Verbose mode -- show the script name before executing it
let g:vimlocal_verbose = 0
## License
Copyright © Richard Russon (flatcap).
Distributed under the GPLv3
## See also
- [flatcap.org](https://flatcap.org)
- [GitHub](https://github.com/flatcap/vim-local)