mirror of
https://github.com/nix-community/nixvim.git
synced 2025-12-05 16:41:06 +01:00
treewide: NixVim/nixvim -> Nixvim
Signed-off-by: saygo-png <saygo.mail@proton.me>
This commit is contained in:
saygo-png
Matt Sturgeon
parent
5d1c27e53c
commit
03a51dbf3d
34 changed files with 78 additions and 78 deletions
2
LICENSE
2
LICENSE
|
|
@ -1,4 +1,4 @@
|
|||
Copyright 2020-2025 NixVim contributors
|
||||
Copyright 2020-2025 Nixvim contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ You can also import inside the submodule:
|
|||
# You can use lib.nixvim in your config
|
||||
fooOption = lib.nixvim.mkRaw "print('hello')";
|
||||
|
||||
# Configure NixVim without prefixing with `plugins.nixvim`
|
||||
# Configure Nixvim without prefixing with `plugins.nixvim`
|
||||
plugins.my-plugin.enable = true;
|
||||
}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
.SH "OPTIONS"
|
||||
.PP
|
||||
You can use the following options in a NixVim module.
|
||||
You can use the following options in a Nixvim module.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "NIXVIM" "5" "01/01/1980" "NixVim" "NixVim Reference Pages"
|
||||
.TH "NIXVIM" "5" "01/01/1980" "Nixvim" "Nixvim Reference Pages"
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
.\" enable line breaks after slashes
|
||||
.cflags 4 /
|
||||
.SH "NAME"
|
||||
NixVim options specification
|
||||
Nixvim options specification
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
This page lists all the options that can be used in NixVim. It can either be used as a Home Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details.
|
||||
This page lists all the options that can be used in Nixvim. It can either be used as a Home Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Structure for nixvim docs
|
||||
# Structure for Nixvim docs
|
||||
|
||||
- [Home](./index.md)
|
||||
|
||||
|
|
@ -27,4 +27,4 @@
|
|||
|
||||
[Contributing](./CONTRIBUTING.md)
|
||||
[Maintaining](./MAINTAINING.md)
|
||||
[NixVim Options Search](./search/index.html)
|
||||
[Nixvim Options Search](./search/index.html)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# NixVim - A Neovim configuration system for nix
|
||||
# Nixvim - A Neovim configuration system for nix
|
||||
|
||||
## Other versions of these docs
|
||||
|
||||
|
|
|
|||
|
|
@ -51,13 +51,13 @@ This will generate a `init.lua` that will contain the comments from each stages:
|
|||
|
||||
## Accessing options used in an existing configuration
|
||||
|
||||
The `config` used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to `<nixvim>.extend`.
|
||||
The `config` used to produce a standalone Nixvim derivation can be accessed as an attribute on the derivation, similar to `<nixvim>.extend`.
|
||||
|
||||
This may be useful if you want unrelated parts of your NixOS, Home Manager or nix-darwin configuration to use the same value as something in your nixvim configuration.
|
||||
This may be useful if you want unrelated parts of your NixOS, Home Manager or nix-darwin configuration to use the same value as something in your Nixvim configuration.
|
||||
|
||||
## Accessing nixvim options
|
||||
## Accessing Nixvim options
|
||||
|
||||
Given a nixvim derivation it is possible to access the module options using `<derivation>.options`.
|
||||
Given a Nixvim derivation it is possible to access the module options using `<derivation>.options`.
|
||||
This can be useful to configure `nixd` for example:
|
||||
|
||||
```nix
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Take a look at these configuration examples below.
|
|||
|
||||
**Note:**\
|
||||
Most of those configurations are using a [standalone build](../platforms/standalone.html), however,
|
||||
all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
|
||||
all of the Nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
|
||||
|
||||
@USER_CONFIGS@
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Using a plugin not supported by nixvim, but packaged in nixpkgs is straightforwa
|
|||
- Register the plugin through `extraPlugins`: `extraPlugins = [pkgs.vimPlugins."<plugin name>"]`.
|
||||
- Configure the plugin through `extraConfigLua`: `extraConfigLua = "require('my-plugin').setup({foo = "bar"})";`
|
||||
|
||||
## How do I use a plugin not yet merged into NixVim or temporarily modify one
|
||||
## How do I use a plugin not yet merged into Nixvim or temporarily modify one
|
||||
|
||||
Copy the module expression formatted like this into a file:
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
|
|||
}
|
||||
```
|
||||
|
||||
Import it into your NixVim configuration and configure it:
|
||||
Import it into your Nixvim configuration and configure it:
|
||||
```nix
|
||||
{
|
||||
# Remove this `programs.nixvim` wrapper for standalone configurations
|
||||
|
|
@ -84,13 +84,13 @@ When using Nixvim, it is possible to encounter errors about something not being
|
|||
```
|
||||
|
||||
This usually means one of two things:
|
||||
- The nixpkgs version is not in line with NixVim (for example nixpkgs nixos-25.11 is used with NixVim master)
|
||||
- The nixpkgs unstable version used with NixVim is not recent enough.
|
||||
- The nixpkgs version is not in line with Nixvim (for example nixpkgs nixos-25.11 is used with Nixvim master)
|
||||
- The nixpkgs unstable version used with Nixvim is not recent enough.
|
||||
|
||||
When building nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`.
|
||||
This is so that nixvim is built against the same nixpkgs revision we're using in our test suite.
|
||||
When building Nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`.
|
||||
This is so that Nixvim is built against the same nixpkgs revision we're using in our test suite.
|
||||
|
||||
If you are building nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours.
|
||||
If you are building Nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours.
|
||||
|
||||
> [!TIP]
|
||||
> Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system.
|
||||
|
|
@ -139,7 +139,7 @@ keymaps = [
|
|||
[`map`]: https://nixos.org/manual/nix/stable/language/builtins#builtins-map
|
||||
[`keymaps`]: ../keymaps
|
||||
|
||||
## How to use system provided binaries instead of nixvim provided ones
|
||||
## How to use system provided binaries instead of Nixvim provided ones
|
||||
|
||||
There are a number of plugins that install extra packages using `nix`, but this can cause issues.
|
||||
For example enabling `plugins.treesitter` could add `gcc` to the PATH of neovim, and this could break workflows that rely on the system provided compiler.
|
||||
|
|
|
|||
|
|
@ -1,25 +1,25 @@
|
|||
# Installation
|
||||
|
||||
You must use a `nixpkgs` version compatible with the nixvim version you choose.
|
||||
You must use a `nixpkgs` version compatible with the Nixvim version you choose.
|
||||
|
||||
The `main` branch requires to use a _very recent_ version of nixpkgs unstable.
|
||||
In order to guarantee the compatibility between nixvim & nixpkgs it is recommended to always update both at the same time.
|
||||
In order to guarantee the compatibility between Nixvim & nixpkgs it is recommended to always update both at the same time.
|
||||
|
||||
When using a `stable` version you must use the corresponding nixvim branch, for example `nixos-25.11` when using NixOS 25.11.
|
||||
When using a `stable` version you must use the corresponding Nixvim branch, for example `nixos-25.11` when using NixOS 25.11.
|
||||
|
||||
Failure to use the correct branch, or an old revision of nixpkgs will likely result in errors of the form `vimPlugins.<name> attribute not found`.
|
||||
|
||||
NixVim can be used in four ways:
|
||||
Nixvim can be used in four ways:
|
||||
- As a NixOS module
|
||||
- As a Home Manager module
|
||||
- As a nix-darwin module
|
||||
- As a standalone derivation
|
||||
|
||||
NixVim is also available for nix flakes, or directly through an import.
|
||||
Nixvim is also available for nix flakes, or directly through an import.
|
||||
|
||||
## Accessing nixvim
|
||||
|
||||
For a direct import you can add nixvim to your configuration as follows:
|
||||
For a direct import you can add Nixvim to your configuration as follows:
|
||||
```nix
|
||||
let
|
||||
nixvim = import (builtins.fetchGit {
|
||||
|
|
@ -45,30 +45,30 @@ When using flakes you can simply add `nixvim` to the inputs:
|
|||
|
||||
## Usage
|
||||
|
||||
NixVim can be used standalone or as a module for NixOS, Home Manager, or nix-darwin.
|
||||
Nixvim can be used standalone or as a module for NixOS, Home Manager, or nix-darwin.
|
||||
|
||||
When used standalone, a custom NixVim derivation is produced that can be used like any other package.
|
||||
When used standalone, a custom Nixvim derivation is produced that can be used like any other package.
|
||||
|
||||
When used as a module, NixVim can be enabled though `programs.nixvim.enable`.
|
||||
When used as a module, Nixvim can be enabled though `programs.nixvim.enable`.
|
||||
|
||||
|
||||
### Usage as a module (NixOS, Home Manager, nix-darwin)
|
||||
|
||||
When using NixVim as a module you must import the NixVim module into your module system.
|
||||
When using Nixvim as a module you must import the Nixvim module into your module system.
|
||||
The three imports are:
|
||||
- `<nixvim>.homeModules.nixvim`
|
||||
- `<nixvim>.nixosModules.nixvim`
|
||||
- `<nixvim>.nixDarwinModules.nixvim`
|
||||
|
||||
`<nixvim>` refers to the way to access nixvim, depending on how you fetched nixvim as described in the previous section.
|
||||
`<nixvim>` refers to the way to access Nixvim, depending on how you fetched Nixvim as described in the previous section.
|
||||
|
||||
The imports can be added as a `imports = [ <nixvim_import> ]` in a configuration file.
|
||||
|
||||
You will then be able to enable nixvim through `programs.nixvim.enable = true`, and configure the
|
||||
You will then be able to enable Nixvim through `programs.nixvim.enable = true`, and configure the
|
||||
options as `programs.nixvim.<path>.<to>.<option> = <value>`.
|
||||
|
||||
> [!TIP]
|
||||
> Use `programs.nixvim.imports` to include modules configuring NixVim so you get NixVim's extended `lib` in the `lib` module argument and you don't have to prefix everything with `programs.nixvim`.
|
||||
> Use `programs.nixvim.imports` to include modules configuring Nixvim so you get Nixvim's extended `lib` in the `lib` module argument and you don't have to prefix everything with `programs.nixvim`.
|
||||
>
|
||||
> <!-- This is also in /docs/lib/index.md -->
|
||||
>
|
||||
|
|
@ -87,29 +87,29 @@ options as `programs.nixvim.<path>.<to>.<option> = <value>`.
|
|||
> # You can use lib.nixvim in your config
|
||||
> fooOption = lib.nixvim.mkRaw "print('hello')";
|
||||
>
|
||||
> # Configure NixVim without prefixing with `plugins.nixvim`
|
||||
> # Configure Nixvim without prefixing with `plugins.nixvim`
|
||||
> plugins.my-plugin.enable = true;
|
||||
> }
|
||||
> ```
|
||||
|
||||
When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for Home Manager, NixOS, and nix-darwin respectively.
|
||||
This is useful if you use nixvim both as part of an environment and standalone.
|
||||
When you use Nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for Home Manager, NixOS, and nix-darwin respectively.
|
||||
This is useful if you use Nixvim both as part of an environment and standalone.
|
||||
|
||||
For more platform-specific options and information, see [Nixvim Platforms](../platforms/index.md).
|
||||
|
||||
### Standalone usage
|
||||
|
||||
When using nixvim as a standalone derivation you can use the following functions, located in `<nixvim>.legacyPackages.${system}`:
|
||||
When using Nixvim as a standalone derivation you can use the following functions, located in `<nixvim>.legacyPackages.${system}`:
|
||||
- `makeNixvim`: A simplified version of `makeNixvimWithModule` for when you only need to specify `module` and the other options can be left as the defaults.
|
||||
This function's only argument is a nixvim module, e.g. `{ extraConfigLua = "print('hi')"; }`
|
||||
This function's only argument is a Nixvim module, e.g. `{ extraConfigLua = "print('hi')"; }`
|
||||
- `makeNixvimWithModule`: This function takes an attribute set of the form: `{pkgs, extraSpecialArgs, module}`.
|
||||
The only required argument is `module`, being a nixvim module. This gives access to the `imports`, `options`, `config` variables, and using functions like `{config, ...}: { ... }`.
|
||||
The only required argument is `module`, being a Nixvim module. This gives access to the `imports`, `options`, `config` variables, and using functions like `{config, ...}: { ... }`.
|
||||
|
||||
There are also some helper functions in `<nixvim>.lib.${system}` like:
|
||||
- `check.mkTestDerivationFromNixvimModule`, taking the same arguments as `makeNixvimWithModule` and generates a check derivation.
|
||||
- `check.mkTestDerivationFromNvim`, taking an attribute set of the form `{name = "<derivation name>"; nvim = <nvim derivation>}`. The `nvim` is the standalone derivation provided by NixVim.
|
||||
- `check.mkTestDerivationFromNvim`, taking an attribute set of the form `{name = "<derivation name>"; nvim = <nvim derivation>}`. The `nvim` is the standalone derivation provided by Nixvim.
|
||||
|
||||
The nixvim derivation can then be used like any other package!
|
||||
The Nixvim derivation can then be used like any other package!
|
||||
|
||||
For an example, see the [nixvim standalone flake template](https://github.com/nix-community/nixvim/blob/main/templates/simple/flake.nix).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{ pkgs, ... }:
|
||||
{
|
||||
programs.nixvim = {
|
||||
# This just enables NixVim.
|
||||
# This just enables Nixvim.
|
||||
# If all you have is this, then there will be little visible difference
|
||||
# when compared to just installing NeoVim.
|
||||
enable = true;
|
||||
|
|
@ -47,7 +47,7 @@
|
|||
# Or lua!
|
||||
extraConfigLua = builtins.readFile ./init.lua;
|
||||
|
||||
# One of the big advantages of NixVim is how it provides modules for
|
||||
# One of the big advantages of Nixvim is how it provides modules for
|
||||
# popular vim plugins
|
||||
# Enabling a plugin this way skips all the boring configuration that
|
||||
# some plugins tend to require.
|
||||
|
|
|
|||
|
|
@ -35,17 +35,17 @@
|
|||
[
|
||||
{
|
||||
name = "checks";
|
||||
help = "Run all nixvim checks";
|
||||
help = "Run all Nixvim checks";
|
||||
# TODO: run tests from the `ci` flake output too?
|
||||
command = ''
|
||||
echo "=> Running all nixvim checks..."
|
||||
echo "=> Running all Nixvim checks..."
|
||||
|
||||
${nix} flake check "$@"
|
||||
'';
|
||||
}
|
||||
{
|
||||
name = "tests";
|
||||
help = "Run nixvim tests";
|
||||
help = "Run Nixvim tests";
|
||||
command =
|
||||
let
|
||||
launchTest = pkgs.writeShellApplication {
|
||||
|
|
@ -67,9 +67,9 @@
|
|||
}
|
||||
{
|
||||
name = "test-lib";
|
||||
help = "Run nixvim library tests";
|
||||
help = "Run Nixvim library tests";
|
||||
command = ''
|
||||
echo "=> Running nixvim library tests for the '${system}' architecture..."
|
||||
echo "=> Running Nixvim library tests for the '${system}' architecture..."
|
||||
|
||||
${nix} build .#checks.${system}.lib-tests "$@"
|
||||
'';
|
||||
|
|
@ -81,9 +81,9 @@
|
|||
}
|
||||
{
|
||||
name = "docs";
|
||||
help = "Build nixvim documentation";
|
||||
help = "Build Nixvim documentation";
|
||||
command = ''
|
||||
echo "=> Building nixvim documentation..."
|
||||
echo "=> Building Nixvim documentation..."
|
||||
|
||||
${nix} build .#docs "$@"
|
||||
'';
|
||||
|
|
@ -92,7 +92,7 @@
|
|||
name = "serve-docs";
|
||||
help = "Build and serve documentation locally";
|
||||
command = ''
|
||||
echo -e "=> Building nixvim documentation...\n"
|
||||
echo -e "=> Building Nixvim documentation...\n"
|
||||
nix run .#docs
|
||||
'';
|
||||
}
|
||||
|
|
@ -104,7 +104,7 @@
|
|||
{
|
||||
name = "diff-plugins";
|
||||
command = ''${./diff-plugins.py} "$@"'';
|
||||
help = "Compare available plugins with another nixvim commit";
|
||||
help = "Compare available plugins with another Nixvim commit";
|
||||
}
|
||||
];
|
||||
};
|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@ from argparse import ArgumentParser, ArgumentTypeError
|
|||
|
||||
def main():
|
||||
"""
|
||||
Main function to compare nixvim plugins with another revision.
|
||||
Main function to compare Nixvim plugins with another revision.
|
||||
"""
|
||||
|
||||
parser = ArgumentParser(description="Compare nixvim plugins with another revision")
|
||||
parser = ArgumentParser(description="Compare Nixvim plugins with another revision")
|
||||
parser.add_argument(
|
||||
"base_flakeref",
|
||||
metavar="before",
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ let
|
|||
else if categorizedMaintainers.nixpkgs ? ${obj.github} then
|
||||
"nixpkgs"
|
||||
else
|
||||
throw "${obj.github} is neither a nixvim or nixpkgs maintainer";
|
||||
throw "${obj.github} is neither a Nixvim or nixpkgs maintainer";
|
||||
};
|
||||
}))
|
||||
lib.listToAttrs
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ def get_project_root() -> Path:
|
|||
|
||||
|
||||
class MetaMaintainerGenerator:
|
||||
"""Generates maintainers list using meta.maintainers from nixvim evaluation."""
|
||||
"""Generates maintainers list using meta.maintainers from Nixvim evaluation."""
|
||||
|
||||
def __init__(self, nixvim_root: Path):
|
||||
self.nixvim_root = nixvim_root
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
};
|
||||
new = {
|
||||
path = ../templates/experimental-flake-parts;
|
||||
description = "An experimental flake template for configuring nixvim using evalNixvim and flake.parts";
|
||||
description = "An experimental flake template for configuring Nixvim using evalNixvim and flake.parts";
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
type = with lib.types; attrsOf anything;
|
||||
description = ''
|
||||
These attributes will be added to the table parameter for the setup function.
|
||||
Typically, it can override NixVim's default settings.
|
||||
Typically, it can override Nixvim's default settings.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
# Inputs
|
||||
|
||||
`flake`
|
||||
: The nixvim flake.
|
||||
: The Nixvim flake.
|
||||
|
||||
`lib`
|
||||
: The final extended lib.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,6 @@
|
|||
options.enableMan = lib.mkOption {
|
||||
type = lib.types.bool;
|
||||
default = true;
|
||||
description = "Install the man pages for NixVim options.";
|
||||
description = "Install the man pages for Nixvim options.";
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ in
|
|||
description = ''
|
||||
When enabled, the language server package will be added to the end of the `PATH` _(suffix)_ instead of the beginning _(prefix)_.
|
||||
|
||||
This can be useful if you want local versions of the language server (e.g. from a devshell) to override the nixvim version.
|
||||
This can be useful if you want local versions of the language server (e.g. from a devshell) to override the Nixvim version.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ in
|
|||
description = ''
|
||||
Whether the config will be included in the wrapper script.
|
||||
|
||||
When enabled, the nixvim config will be passed to `nvim` using the `-u` option.
|
||||
When enabled, the Nixvim config will be passed to `nvim` using the `-u` option.
|
||||
'';
|
||||
defaultText = lib.literalMD ''
|
||||
Configured by your installation method: `false` when using the Home Manager module, `true` otherwise.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ in
|
|||
|
||||
buildNixvim = lib.mkOption {
|
||||
type = lib.types.bool;
|
||||
description = "Whether to build the nixvim config in the test.";
|
||||
description = "Whether to build the Nixvim config in the test.";
|
||||
default = true;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ lib: {
|
|||
"coverage"
|
||||
];
|
||||
message = ''
|
||||
Use nixvim top-level `keyamps` option to manually declare your 'nvim-coverage' keymaps.
|
||||
Use Nixvim top-level `keyamps` option to manually declare your 'nvim-coverage' keymaps.
|
||||
'';
|
||||
in
|
||||
[
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
|
|||
- ImageMagick is required for Sixel encoding
|
||||
|
||||
> [!Note]
|
||||
> When choosing the `"ueberzug"` backend, nixvim will automatically add `ueberzugpp` as a dependency.
|
||||
> When choosing the `"ueberzug"` backend, Nixvim will automatically add `ueberzugpp` as a dependency.
|
||||
> Set `ueberzugPackage = null` to disable this behavior.
|
||||
'';
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ in
|
|||
type = with lib.types; attrsOf str;
|
||||
default = { };
|
||||
description = ''
|
||||
Internal option used to associate nvim-cmp source names with nixvim plugin module names.
|
||||
Internal option used to associate nvim-cmp source names with Nixvim plugin module names.
|
||||
|
||||
Maps `<source-name> = <plugin-name>` where _plugin-name_ is the module name: `plugins.<plugin-name>.enable`.
|
||||
'';
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
|
|||
plugins. This is the default behavior, but will work only when this option is set to a list.
|
||||
|
||||
If you use a raw lua string or set `plugins.cmp.autoEnableSources` to `false`, you will need to explicitly enable the relevant source plugins in
|
||||
your nixvim configuration.
|
||||
your Nixvim configuration.
|
||||
|
||||
#### With auto-enabled sources
|
||||
```nix
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ lib.mkOption {
|
|||
If `plugins.cmp.autoEnableSources` Nixivm will automatically enable the corresponding source
|
||||
plugins. This will work only when this option is set to a list.
|
||||
If you use a raw lua string, you will need to explicitly enable the relevant source plugins in
|
||||
your nixvim configuration.
|
||||
your Nixvim configuration.
|
||||
'';
|
||||
example = [
|
||||
{ name = "nvim_lsp"; }
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ in
|
|||
description = ''
|
||||
When enabled, the language server package will be added to the end of the `PATH` _(suffix)_ instead of the beginning _(prefix)_.
|
||||
|
||||
This can be useful if you want local versions of the language server (e.g. from a devshell) to override the nixvim version.
|
||||
This can be useful if you want local versions of the language server (e.g. from a devshell) to override the Nixvim version.
|
||||
'';
|
||||
apply = v: if enabled then config.lsp.servers.${serverName}.packageFallback else v;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# New Nixvim template
|
||||
|
||||
This template gives you a good starting point for configuring nixvim as a standalone module configuration.
|
||||
This template gives you a good starting point for configuring Nixvim as a standalone module configuration.
|
||||
|
||||
## Configuring
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ nix run
|
|||
|
||||
## Configurations and packages
|
||||
|
||||
Your nixvim configuration is created using `evalNixvim`.
|
||||
Your Nixvim configuration is created using `evalNixvim`.
|
||||
This is outputted as the `nixvimConfigurations.<system>.default` flake output.
|
||||
|
||||
You can access your configuration's package outputs `<configuration>.config.build.package`.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
description = "A nixvim configuration";
|
||||
description = "A Nixvim configuration";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Nixvim template
|
||||
|
||||
This template gives you a good starting point for configuring nixvim standalone.
|
||||
This template gives you a good starting point for configuring Nixvim standalone.
|
||||
|
||||
## Configuring
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
description = "A nixvim configuration";
|
||||
description = "A Nixvim configuration";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ let
|
|||
in
|
||||
runCommandLocal "maintainers-test" { inherit count duplicates; } ''
|
||||
if [ $count -gt 0 ]; then
|
||||
echo "$count nixvim maintainers are also nixpkgs maintainers:"
|
||||
echo "$count Nixvim maintainers are also nixpkgs maintainers:"
|
||||
for name in $duplicates; do
|
||||
echo "- $name"
|
||||
done
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
meta.wrapper = {
|
||||
name = lib.mkOption {
|
||||
type = lib.types.str;
|
||||
description = "The human-readable name of this nixvim wrapper. Used in documentation.";
|
||||
description = "The human-readable name of this Nixvim wrapper. Used in documentation.";
|
||||
internal = true;
|
||||
};
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue