movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 21:50:33 +03:00
Code Activity

Update grammar in vim section

Browse source 
Fixed a few grammatical issues. Was uncertain how to address Treesitter, as the homepage itself is inconsistent, using all combinations of Treesitter, Tree-sitter, treesitter and tree-sitter.
This commit is contained in:
Jayson Henkel 2022-07-07 22:22:52 -07:00 • committed by Bjørn Forsman
parent 1014f00cff
commit cb7bea1312
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/languages-frameworks/vim.section.md
View file

@ -7,7 +7,7 @@ Loading can be deferred; see examples.
At the moment we support three different methods for managing plugins: At the moment we support three different methods for managing plugins:
- Vim packages (*recommend*) - Vim packages (*recommended*)
- VAM (=vim-addon-manager) - VAM (=vim-addon-manager)
- Pathogen - Pathogen
- vim-plug - vim-plug
@ -45,7 +45,7 @@ neovim.override {
``` ```
If you want to use `neovim-qt` as a graphical editor, you can configure it by overriding Neovim in an overlay If you want to use `neovim-qt` as a graphical editor, you can configure it by overriding Neovim in an overlay
or passing it an overridden Neovimn: or passing it an overridden Neovim:
```nix ```nix
neovim-qt.override { neovim-qt.override {
@ -61,7 +61,7 @@ neovim-qt.override {
## Managing plugins with Vim packages {#managing-plugins-with-vim-packages} ## Managing plugins with Vim packages {#managing-plugins-with-vim-packages}
To store you plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used: To store your plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used:
```nix ```nix
vim_configurable.customize { vim_configurable.customize {
@ -110,7 +110,7 @@ The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.n
}; };
myNeovim = neovim.override { myNeovim = neovim.override {
configure = { configure = {
# add here code from the example section # add code from the example section here
}; };
}; };
}; };
@ -158,10 +158,10 @@ in
``` ```
### Specificities for some plugins ### Specificities for some plugins
#### Tree sitter #### Treesitter
By default `nvim-treesitter` encourages you to download, compile and install By default `nvim-treesitter` encourages you to download, compile and install
the required tree-sitter grammars at run time with `:TSInstall`. This works the required Treesitter grammars at run time with `:TSInstall`. This works
poorly on NixOS. Instead, to install the `nvim-treesitter` plugins with a set poorly on NixOS. Instead, to install the `nvim-treesitter` plugins with a set
of precompiled grammars, you can use `nvim-treesitter.withPlugins` function: of precompiled grammars, you can use `nvim-treesitter.withPlugins` function:
@ -204,7 +204,7 @@ For Neovim the syntax is:
neovim.override { neovim.override {
configure = { configure = {
customRC = '' customRC = ''
# here your custom configuration goes! # your custom configuration goes here!
''; '';
plug.plugins = with pkgs.vimPlugins; [ plug.plugins = with pkgs.vimPlugins; [
vim-go vim-go
@ -230,7 +230,7 @@ First create a vim-scripts file having one plugin name per line. Example:
{'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']} {'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']}
``` ```
Such vim-scripts file can be read by VAM as well like this: A discrete vim-scripts file can be read by VAM as well like this:
```vim ```vim
call vam#Scripts(expand('~/.vim-scripts'), {}) call vam#Scripts(expand('~/.vim-scripts'), {})
@ -323,7 +323,7 @@ Sometimes plugins require an override that must be changed when the plugin is up
To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running. To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running.
Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of Language Server Protocol integration with vim/neovim. Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of the Language Server Protocol integration with vim/neovim.
## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs} ## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs}