Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativenull/projectlocal.vim
Safely load your project specific configurations written in json, lua or vimscript
https://github.com/creativenull/projectlocal.vim
denops nvim nvim-plugin plugin vim vim-denops vim-plugin
Last synced: 10 days ago
JSON representation
Safely load your project specific configurations written in json, lua or vimscript
- Host: GitHub
- URL: https://github.com/creativenull/projectlocal.vim
- Owner: creativenull
- License: mit
- Created: 2021-08-02T16:31:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T17:13:38.000Z (5 months ago)
- Last Synced: 2024-11-02T09:31:54.764Z (17 days ago)
- Topics: denops, nvim, nvim-plugin, plugin, vim, vim-denops, vim-plugin
- Language: TypeScript
- Homepage:
- Size: 165 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# projectlocal.vim
[](https://github.com/denoland/deno/tree/v1.28)
[](https://github.com/vim/vim/tree/v9.0.0472)
[](https://github.com/neovim/neovim/tree/v0.8.0)
Load your vim project local configurations safely, for vim and neovim. Written with ♥ in TypeScript and Deno
([denops.vim][denops]).
This is a combination of my [projectcmd.vim][pcmdvim] and [projectcmd.nvim][pcmdnvim] plugins with the aim to unify both
plugins to support both vim and neovim.
## Features
+ Setup configurations on a per-project basis
+ Write your configurations in a vimscript, lua or json file
+ Run only on user permission - when a config file is found inside a project, the user will get to decide whether to
run those configurations or not
## Requirements
+ [deno v1.28 and up](https://deno.land)
+ [denops.vim v4 and up][denops]
+ Vim 9.0.0472 and up (`:version`)
+ Neovim 0.8.0 and up (`:version`)
## Installation
You must have [deno installed for this plugin to work on your machine](https://deno.land)
Below are examples on installing the plugin with a plugin manager or utilizing vim packages.
### vim-plug
```vim
Plug 'vim-denops/denops.vim'
Plug 'creativenull/projectlocal.vim'
" Or use with tag (optional)
" Plug 'creativenull/projectlocal.vim', { 'tag': 'v1.*' }
```
### packer.nvim
```lua
use {
'creativenull/projectlocal.vim',
tag = 'v1.*', -- optional
requires = { 'vim-denops/denops.vim' },
}
```
### lazy.nvim
```lua
{
'creativenull/projectlocal.vim',
version = 'v1.x.x', -- optional
dependencies = { 'vim-denops/denops.vim' }
}
```
### Without any manager
#### Vim
```sh
git clone --depth 1 --branch v1.0.0 https://github.com/creativenull/projectlocal.vim ~/.vim/pack/creativenull/start/projectlocal.vim
```
#### Neovim
```sh
git clone --depth 1 --branch v1.0.0 https://github.com/creativenull/projectlocal.vim ~/.local/share/nvim/site/pack/creativenull/start/projectlocal.vim
```
## How to use
[Check the How to use section in the Wiki page.](https://github.com/creativenull/projectlocal.vim/wiki#how-to-use)
## Motivation
[Read why I created this plugin in the Motivation wiki page.](https://github.com/creativenull/projectlocal.vim/wiki/Motivation)
## Documentation
The documentation can be found over at [docs/projectlocal.txt][docs] and via vim/nvim after installation with
`:help projectlocal`.
For a JSON config file check `:help projectlocal-json-config`.
## Contributing
Make sure you have Deno installed. If you encounter a bug or have an issue, you can make PR with your reasoning. But I
would recommend you create an Issue first before making a PR to expand more on the issue you're having.
[vim-exrc]: https://vimhelp.org/options.txt.html#'exrc'
[vim-secure]: https://vimhelp.org/options.txt.html#'secure'
[denops]: https://github.com/vim-denops/denops.vim
[pcmdvim]: https://github.com/creativenull/projectcmd.vim
[pcmdnvim]: https://github.com/creativenull/projectcmd.nvim
[docs]: doc/projectlocal.txt
[efmls-configs]: https://github.com/creativenull/efmls-configs-nvim
[diagnosticls-configs]: https://github.com/creativenull/diagnosticls-configs-nvim
[ale]: https://github.com/dense-analysis/ale
[null-ls]: https://github.com/jose-elias-alvarez/null-ls.nvim
[nvim-lint]: https://github.com/mfussenegger/nvim-lint
[neoformat]: https://github.com/sbdchd/neoformat
[neomake]: https://github.com/neomake/neomake