mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-07-15 03:34:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

modules/lsp/server: rename config -> settings

Browse source 
`config` is a loaded term within modules and options.

`settings` is the name usually used for freeform config in nixvim and
most other module configurations.
This commit is contained in:
Matt Sturgeon 2025-04-30 17:30:30 +01:00
parent fc6f00a7fd
commit 21688b1d2a
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 38 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

28
modules/lsp/server.nix
View file

@ -2,9 +2,7 @@
{
name ? null,
package ? null,
# Avoid naming conflict with the `config` module arg
# TODO: consider renaming the `config` option to something like `settings`?
configOption ? null,
settings ? null,
pkgs ? { },
}@args:
{ lib, name, ... }:
@ -48,14 +46,14 @@ in
'';
};
config = lib.mkOption {
settings = lib.mkOption {
type = with types; attrsOf anything;
description = ''
Configurations for ${displayName}. ${configOption.extraDescription or ""}
Configurations for ${displayName}. ${settings.extraDescription or ""}
'';
default = { };
example =
configOption.example or {
settings.example or {
cmd = [
"clangd"
"--background-index"
@ -70,5 +68,23 @@ in
];
};
};
# NOTE: we need a warnings option for `mkRenamedOptionModule` to warn about unexpected definitions
# This can be removed when all rename aliases are gone
warnings = lib.mkOption {
type = with types; listOf str;
description = "Warnings to propagate to nixvim's `warnings` option.";
default = [ ];
internal = true;
visible = false;
};
};
imports = [
# TODO: rename added 2025-04-30 (during the 25.05 cycle)
# The previous name `config` was introduced 2025-04-28 (during the 25.05 cycle)
# Because the previous name `config` never made it into a stable release,
# we could consider dropping this alias sooner than normal.
(lib.mkRenamedOptionModule [ "config" ] [ "settings" ])
];
}