mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-21 00:25:42 +02:00
plugins/none-ls: refactor using mkSourcePlugin
Introduce `_mk-source-plugin.nix`, which returns a module handling a specific none-ls source plugin. This wasn't possible previously due to IFD conflicting with evaluating module imports. Adjusted the test to use the `options` provided via module args, and cleaned up some stuff allowing "unpackaged" sources to not be listed again in the test file.
This commit is contained in:
Matt Sturgeon
parent
195978e627
commit
d8f3113e90
4 changed files with 130 additions and 162 deletions
58
plugins/none-ls/_mk-source-plugin.nix
Normal file
58
plugins/none-ls/_mk-source-plugin.nix
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# mkSourcePlugin, returns a module
|
||||
sourceType: sourceName:
|
||||
{
|
||||
config,
|
||||
pkgs,
|
||||
lib,
|
||||
helpers,
|
||||
...
|
||||
}:
|
||||
let
|
||||
inherit (import ./packages.nix pkgs) packaged unpackaged;
|
||||
|
||||
cfg = config.plugins.none-ls;
|
||||
cfg' = config.plugins.none-ls.sources.${sourceType}.${sourceName};
|
||||
in
|
||||
{
|
||||
options.plugins.none-ls.sources.${sourceType}.${sourceName} =
|
||||
{
|
||||
enable = lib.mkEnableOption "the ${sourceName} ${sourceType} source for none-ls";
|
||||
withArgs = helpers.mkNullOrOption helpers.nixvimTypes.strLua ''
|
||||
Raw Lua code passed as an argument to the source's `with` method.
|
||||
'';
|
||||
}
|
||||
# Only declare a package option if a package is required
|
||||
// lib.optionalAttrs (packaged ? ${sourceName} || lib.elem sourceName unpackaged) {
|
||||
package =
|
||||
let
|
||||
pkg = packaged.${sourceName} or null;
|
||||
in
|
||||
lib.mkOption (
|
||||
{
|
||||
type = lib.types.nullOr lib.types.package;
|
||||
description =
|
||||
"Package to use for ${sourceName}."
|
||||
+ (lib.optionalString (pkg == null) (
|
||||
"\n\n"
|
||||
+ ''
|
||||
Currently not packaged in nixpkgs.
|
||||
Either set this to `null` and install ${sourceName} outside of nix,
|
||||
or set this to a custom nix package.
|
||||
''
|
||||
));
|
||||
}
|
||||
// lib.optionalAttrs (pkg != null) { default = pkg; }
|
||||
);
|
||||
};
|
||||
|
||||
config = lib.mkIf (cfg.enable && cfg'.enable) {
|
||||
plugins.none-ls.settings.sources = lib.mkDefault [
|
||||
(
|
||||
"require('null-ls').builtins.${sourceType}.${sourceName}"
|
||||
+ lib.optionalString (cfg'.withArgs != null) ".with(${cfg'.withArgs})"
|
||||
)
|
||||
];
|
||||
|
||||
extraPackages = [ (cfg'.package or null) ];
|
||||
};
|
||||
}
|
||||
|
|
@ -1,82 +1,22 @@
|
|||
{
|
||||
pkgs,
|
||||
config,
|
||||
lib,
|
||||
helpers,
|
||||
...
|
||||
}:
|
||||
{ config, lib, ... }:
|
||||
let
|
||||
noneLsBuiltins = import ../../generated/none-ls.nix;
|
||||
|
||||
inherit (import ./packages.nix pkgs) packaged unpackaged;
|
||||
|
||||
# Does this builitin require a package ?
|
||||
builitinNeedsPackage = source: lib.hasAttr source packaged || lib.elem source unpackaged;
|
||||
mkSourcePlugin = import ./_mk-source-plugin.nix;
|
||||
in
|
||||
{
|
||||
imports = [ ./prettier.nix ];
|
||||
|
||||
options.plugins.none-ls.sources = lib.mapAttrs (
|
||||
sourceType: sources:
|
||||
lib.listToAttrs (
|
||||
lib.map (source: {
|
||||
name = source;
|
||||
value =
|
||||
{
|
||||
enable = lib.mkEnableOption "the ${source} ${sourceType} source for none-ls";
|
||||
withArgs = helpers.mkNullOrOption helpers.nixvimTypes.strLua ''
|
||||
Raw Lua code passed as an argument to the source's `with` method.
|
||||
'';
|
||||
}
|
||||
// lib.optionalAttrs (builitinNeedsPackage source) {
|
||||
package =
|
||||
let
|
||||
pkg = packaged.${source} or null;
|
||||
in
|
||||
lib.mkOption (
|
||||
{
|
||||
type = lib.types.nullOr lib.types.package;
|
||||
description =
|
||||
"Package to use for ${source} by none-ls. "
|
||||
+ (lib.optionalString (pkg == null) ''
|
||||
Not handled in nixvim, either install externally and set to null or set the option with a derivation.
|
||||
'');
|
||||
}
|
||||
// lib.optionalAttrs (pkg != null) { default = pkg; }
|
||||
);
|
||||
};
|
||||
}) sources
|
||||
)
|
||||
) noneLsBuiltins;
|
||||
imports =
|
||||
[ ./prettier.nix ]
|
||||
++ (lib.flatten (
|
||||
lib.mapAttrsToList (category: (lib.map (mkSourcePlugin category))) noneLsBuiltins
|
||||
));
|
||||
|
||||
config =
|
||||
let
|
||||
cfg = config.plugins.none-ls;
|
||||
gitsignsEnabled = cfg.sources.code_actions.gitsigns.enable;
|
||||
|
||||
flattenedSources = lib.flatten (
|
||||
lib.mapAttrsToList (
|
||||
sourceType: sources:
|
||||
(lib.mapAttrsToList (sourceName: source: source // { inherit sourceType sourceName; }) sources)
|
||||
) cfg.sources
|
||||
);
|
||||
|
||||
enabledSources = builtins.filter (source: source.enable) flattenedSources;
|
||||
in
|
||||
lib.mkIf cfg.enable {
|
||||
plugins.none-ls.settings.sources = lib.mkIf (enabledSources != [ ]) (
|
||||
map (
|
||||
{
|
||||
sourceType,
|
||||
sourceName,
|
||||
withArgs,
|
||||
...
|
||||
}:
|
||||
"require('null-ls').builtins.${sourceType}.${sourceName}"
|
||||
+ lib.optionalString (withArgs != null) ".with(${withArgs})"
|
||||
) enabledSources
|
||||
);
|
||||
# Enable gitsigns if the gitsigns source is enabled
|
||||
plugins.gitsigns.enable = lib.mkIf gitsignsEnabled true;
|
||||
extraPackages = map (source: source.package or null) enabledSources;
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -53,10 +53,6 @@ let
|
|||
inherit pkgs lib helpers;
|
||||
config = { };
|
||||
};
|
||||
nonels-sources-options = import ../plugins/none-ls/servers.nix {
|
||||
inherit pkgs lib helpers;
|
||||
config = { };
|
||||
};
|
||||
};
|
||||
inherit namespace;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
{ pkgs, nonels-sources-options, ... }:
|
||||
{
|
||||
# Empty configuration
|
||||
empty = {
|
||||
|
|
@ -100,65 +99,35 @@
|
|||
};
|
||||
|
||||
with-sources = {
|
||||
module =
|
||||
{
|
||||
config,
|
||||
options,
|
||||
lib,
|
||||
pkgs,
|
||||
...
|
||||
}:
|
||||
{
|
||||
plugins.none-ls = {
|
||||
# sandbox-exec: pattern serialization length 159032 exceeds maximum (65535)
|
||||
enable = !pkgs.stdenv.isDarwin;
|
||||
|
||||
sources =
|
||||
let
|
||||
options = nonels-sources-options.options.plugins.none-ls.sources;
|
||||
|
||||
unpackaged =
|
||||
disabled =
|
||||
[
|
||||
"blade_formatter"
|
||||
"bsfmt"
|
||||
"bslint"
|
||||
"cljstyle"
|
||||
"cueimports"
|
||||
# As of 2024-03-22, pkgs.d2 is broken
|
||||
# TODO: re-enable this test when fixed
|
||||
"d2_fmt"
|
||||
"erb_lint"
|
||||
"findent"
|
||||
"forge_fmt"
|
||||
"gccdiag"
|
||||
"gersemi"
|
||||
"markuplint"
|
||||
"mlint"
|
||||
"nginx_beautifier"
|
||||
"npm_groovy_lint"
|
||||
"ocdc"
|
||||
"packer"
|
||||
"perlimports"
|
||||
"pint"
|
||||
"pretty_php"
|
||||
"purs_tidy"
|
||||
"pyink"
|
||||
"reek"
|
||||
"regal"
|
||||
"remark"
|
||||
"rescript"
|
||||
"saltlint"
|
||||
"solhint"
|
||||
"spectral"
|
||||
"sqlfmt"
|
||||
"sql_formatter"
|
||||
"styler"
|
||||
"stylint"
|
||||
"swiftformat"
|
||||
"swiftlint"
|
||||
"textidote"
|
||||
"textlint"
|
||||
"twigcs"
|
||||
"vacuum"
|
||||
# TODO: can this be re-enabled?
|
||||
"yamlfix"
|
||||
]
|
||||
++ (pkgs.lib.optionals (pkgs.stdenv.isDarwin && pkgs.stdenv.isx86_64) [
|
||||
++ (lib.optionals (pkgs.stdenv.isDarwin && pkgs.stdenv.isx86_64) [
|
||||
# As of 2024-03-27, pkgs.graalvm-ce (a dependency of pkgs.clj-kondo) is broken on x86_64-darwin
|
||||
# TODO: re-enable this test when fixed
|
||||
"clj_kondo"
|
||||
])
|
||||
++ (pkgs.lib.optionals pkgs.stdenv.isDarwin [
|
||||
++ (lib.optionals pkgs.stdenv.isDarwin [
|
||||
# As of 2024-05-22, python311Packages.k5test (one of ansible-lint's dependenvies) is broken on darwin
|
||||
# TODO: re-enable this test when fixed
|
||||
"ansible_lint"
|
||||
|
|
@ -172,23 +141,28 @@
|
|||
"verilator"
|
||||
"verible_verilog_format"
|
||||
])
|
||||
++ (pkgs.lib.optionals pkgs.stdenv.isAarch64 [
|
||||
++ (lib.optionals pkgs.stdenv.isAarch64 [
|
||||
"semgrep"
|
||||
"smlfmt"
|
||||
# As of 2024-03-11, swift-format is broken on aarch64
|
||||
# TODO: re-enable this test when fixed
|
||||
"swift_format"
|
||||
]);
|
||||
|
||||
sources = pkgs.lib.mapAttrs (
|
||||
_: sources:
|
||||
pkgs.lib.mapAttrs (
|
||||
source: _:
|
||||
{ enable = true; } // pkgs.lib.optionalAttrs (builtins.elem source unpackaged) { package = null; }
|
||||
) sources
|
||||
) options;
|
||||
in
|
||||
sources;
|
||||
# Enable every none-ls source that has an option
|
||||
lib.mapAttrs (
|
||||
_:
|
||||
lib.mapAttrs (
|
||||
sourceName: opts:
|
||||
{
|
||||
# Enable unless disabled above
|
||||
enable = !(lib.elem sourceName disabled);
|
||||
}
|
||||
# Some sources have a package option with no default
|
||||
// lib.optionalAttrs (opts ? package && !(opts.package ? default)) { package = null; }
|
||||
)
|
||||
) options.plugins.none-ls.sources;
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue