diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2022-10-31 18:03:46 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-31 18:03:46 +0000 |
commit | 85d6819fff29b97cb0c4e6a88517456c8688e11f (patch) | |
tree | 6cecd8131abaaf0f7a8d753a8baeb9378c00b6d2 /doc | |
parent | 065e2fe7fb35fb0a03db35136228dd9e68280e93 (diff) | |
parent | 194c35c5e499118f4f89fde73763efff6e733875 (diff) |
Merge staging-next into staging
Diffstat (limited to 'doc')
-rw-r--r-- | doc/languages-frameworks/vim.section.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md index 087e593086f00..399477c041ab2 100644 --- a/doc/languages-frameworks/vim.section.md +++ b/doc/languages-frameworks/vim.section.md @@ -170,8 +170,8 @@ of precompiled grammars, you can use `nvim-treesitter.withPlugins` function: start = [ (nvim-treesitter.withPlugins ( plugins: with plugins; [ - tree-sitter-nix - tree-sitter-python + nix + python ] )) ]; @@ -180,7 +180,7 @@ of precompiled grammars, you can use `nvim-treesitter.withPlugins` function: }) ``` -To enable all grammars packaged in nixpkgs, use `(pkgs.vimPlugins.nvim-treesitter.withPlugins (plugins: pkgs.tree-sitter.allGrammars))`. +To enable all grammars packaged in nixpkgs, use `pkgs.vimPlugins.nvim-treesitter.withAllGrammars`. ## Managing plugins with vim-plug {#managing-plugins-with-vim-plug} @@ -203,6 +203,8 @@ Note: this is not possible anymore for Neovim. Nix expressions for Vim plugins are stored in [pkgs/applications/editors/vim/plugins](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/editors/vim/plugins). For the vast majority of plugins, Nix expressions are automatically generated by running [`./update.py`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/update.py). This creates a [generated.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/generated.nix) file based on the plugins listed in [vim-plugin-names](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/vim-plugin-names). Plugins are listed in alphabetical order in `vim-plugin-names` using the format `[github username]/[repository]@[gitref]`. For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`. +After running `./update.py`, if nvim-treesitter received an update, also run [`nvim-treesitter/update.py`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/update.py) to update the tree sitter grammars for `nvim-treesitter`. + Some plugins require overrides in order to function properly. Overrides are placed in [overrides.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/overrides.nix). Overrides are most often required when a plugin requires some dependencies, or extra steps are required during the build process. For example `deoplete-fish` requires both `deoplete-nvim` and `vim-fish`, and so the following override was added: ```nix |