mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-24 17:58:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

plugins/neotest: migrate helpers -> lib.nixvim

Browse source
This commit is contained in:
Austin Horstman 2024-08-21 23:46:46 -05:00
parent 511a328aa3
commit d7b506efdd
No known key found for this signature in database
3 changed files with 51 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

10
plugins/neotest/adapters.nix
View file

@ -1,12 +1,12 @@
{ {
lib, lib,
config, config,
helpers,
pkgs, pkgs,
... ...
}: }:
with lib; with lib;
let let
inherit (lib.nixvim) mkPluginPackageOption mkSettingsOption;
supportedAdapters = import ./adapters-list.nix; supportedAdapters = import ./adapters-list.nix;
mkAdapter = mkAdapter =
@ -20,9 +20,9 @@ let
options.plugins.neotest.adapters.${name} = { options.plugins.neotest.adapters.${name} = {
enable = mkEnableOption name; enable = mkEnableOption name;
package = helpers.mkPluginPackageOption name pkgs.vimPlugins.${packageName}; package = mkPluginPackageOption name pkgs.vimPlugins.${packageName};
settings = helpers.mkSettingsOption { description = "settings for the `${name}` adapter."; }; settings = mkSettingsOption { description = "settings for the `${name}` adapter."; };
}; };
config = config =
@ -46,9 +46,7 @@ let
plugins.neotest.settings.adapters = plugins.neotest.settings.adapters =
let let
settingsString = optionalString (cfg.settings != { }) ( settingsString = optionalString (cfg.settings != { }) (settingsSuffix (toLuaObject cfg.settings));
settingsSuffix (helpers.toLuaObject cfg.settings)
);
in in
[ "require('neotest-${name}')${settingsString}" ]; [ "require('neotest-${name}')${settingsString}" ];
}; };

12
plugins/neotest/default.nix
View file

@ -1,12 +1,14 @@
{ {
lib, lib,
helpers,
config, config,
pkgs, pkgs,
... ...
}: }:
with lib; with lib;
helpers.neovim-plugin.mkNeovimPlugin config { let
inherit (lib.nixvim) mkRaw;
in
lib.nixvim.neovim-plugin.mkNeovimPlugin config {
name = "neotest"; name = "neotest";
defaultPackage = pkgs.vimPlugins.neotest; defaultPackage = pkgs.vimPlugins.neotest;
@ -14,11 +16,11 @@ helpers.neovim-plugin.mkNeovimPlugin config {
imports = [ ./adapters.nix ]; imports = [ ./adapters.nix ];
settingsOptions = (import ./options.nix { inherit lib helpers; }) // { settingsOptions = (import ./options.nix { inherit lib; }) // {
adapters = mkOption { adapters = mkOption {
type = with helpers.nixvimTypes; listOf strLua; type = with types; listOf strLua;
default = [ ]; default = [ ];
apply = map helpers.mkRaw; apply = map mkRaw;
# NOTE: We hide this option from the documentation as users should use the top-level # NOTE: We hide this option from the documentation as users should use the top-level
# `adapters` option. # `adapters` option.
# They can still directly append raw lua code to this `settings.adapters` option. # They can still directly append raw lua code to this `settings.adapters` option.

77
plugins/neotest/options.nix
View file

@ -1,19 +1,22 @@
{ lib, helpers }: { lib }:
with lib; with lib;
let
inherit (lib.nixvim) defaultNullOpts mkNullOrOption mkNullOrLuaFn;
in
{ {
################################################# #################################################
# CoreConfig # CoreConfig
discovery = { discovery = {
enabled = helpers.defaultNullOpts.mkBool true "Enable discovery."; enabled = defaultNullOpts.mkBool true "Enable discovery.";
concurrent = helpers.defaultNullOpts.mkUnsignedInt 0 '' concurrent = defaultNullOpts.mkUnsignedInt 0 ''
Number of workers to parse files concurrently. Number of workers to parse files concurrently.
0 automatically assigns number based on CPU. 0 automatically assigns number based on CPU.
Set to 1 if experiencing lag. Set to 1 if experiencing lag.
''; '';
filter_dir = helpers.mkNullOrLuaFn '' filter_dir = mkNullOrLuaFn ''
`fun(name: string, rel_path: string, root: string): boolean` `fun(name: string, rel_path: string, root: string): boolean`
A function to filter directories when searching for test files. A function to filter directories when searching for test files.
@ -22,28 +25,28 @@ with lib;
}; };
running = { running = {
concurrent = helpers.defaultNullOpts.mkBool true '' concurrent = defaultNullOpts.mkBool true ''
Run tests concurrently when an adapter provides multiple commands to run. Run tests concurrently when an adapter provides multiple commands to run.
''; '';
}; };
default_strategy = helpers.defaultNullOpts.mkStr "integrated" '' default_strategy = defaultNullOpts.mkStr "integrated" ''
The default strategy. The default strategy.
''; '';
################################################# #################################################
# Config # Config
log_level = helpers.defaultNullOpts.mkLogLevel "warn" '' log_level = defaultNullOpts.mkLogLevel "warn" ''
Minimum log levels. Minimum log levels.
''; '';
consumers = helpers.defaultNullOpts.mkAttrsOf helpers.nixvimTypes.strLuaFn { } '' consumers = defaultNullOpts.mkAttrsOf types.strLuaFn { } ''
key: string key: string
value: lua function value: lua function
''; '';
icons = helpers.defaultNullOpts.mkAttrsOf (with types; either str (listOf str)) { icons = defaultNullOpts.mkAttrsOf (with types; either str (listOf str)) {
child_indent = "│"; child_indent = "│";
child_prefix = "├"; child_prefix = "├";
collapsed = "─"; collapsed = "─";
@ -69,7 +72,7 @@ with lib;
watching = ""; watching = "";
} "Icons used throughout the UI. Defaults use VSCode's codicons."; } "Icons used throughout the UI. Defaults use VSCode's codicons.";
highlights = helpers.defaultNullOpts.mkAttrsOf types.str { highlights = defaultNullOpts.mkAttrsOf types.str {
adapter_name = "NeotestAdapterName"; adapter_name = "NeotestAdapterName";
border = "NeotestBorder"; border = "NeotestBorder";
dir = "NeotestDir"; dir = "NeotestDir";
@ -91,43 +94,43 @@ with lib;
} ""; } "";
floating = { floating = {
border = helpers.defaultNullOpts.mkStr "rounded" "Border style."; border = defaultNullOpts.mkStr "rounded" "Border style.";
max_height = helpers.defaultNullOpts.mkNullable (types.numbers.between 0.0 1.0) 0.6 '' max_height = defaultNullOpts.mkNullable (types.numbers.between 0.0 1.0) 0.6 ''
Max height of window as proportion of NeoVim window. Max height of window as proportion of NeoVim window.
''; '';
max_width = helpers.defaultNullOpts.mkNullable (types.numbers.between 0.0 1.0) 0.6 '' max_width = defaultNullOpts.mkNullable (types.numbers.between 0.0 1.0) 0.6 ''
Max width of window as proportion of NeoVim window. Max width of window as proportion of NeoVim window.
''; '';
options = helpers.defaultNullOpts.mkAttrsOf types.anything { } '' options = defaultNullOpts.mkAttrsOf types.anything { } ''
Window local options to set on floating windows (e.g. winblend). Window local options to set on floating windows (e.g. winblend).
''; '';
}; };
strategies = { strategies = {
integrated = { integrated = {
height = helpers.defaultNullOpts.mkUnsignedInt 40 '' height = defaultNullOpts.mkUnsignedInt 40 ''
height to pass to the pty running commands. height to pass to the pty running commands.
''; '';
width = helpers.defaultNullOpts.mkUnsignedInt 120 '' width = defaultNullOpts.mkUnsignedInt 120 ''
Width to pass to the pty running commands. Width to pass to the pty running commands.
''; '';
}; };
}; };
summary = { summary = {
enabled = helpers.defaultNullOpts.mkBool true "Whether to enable summary."; enabled = defaultNullOpts.mkBool true "Whether to enable summary.";
animated = helpers.defaultNullOpts.mkBool true "Enable/disable animation of icons."; animated = defaultNullOpts.mkBool true "Enable/disable animation of icons.";
follow = helpers.defaultNullOpts.mkBool true "Expand user's current file."; follow = defaultNullOpts.mkBool true "Expand user's current file.";
expandErrors = helpers.defaultNullOpts.mkBool true "Expand all failed positions."; expandErrors = defaultNullOpts.mkBool true "Expand all failed positions.";
mappings = helpers.defaultNullOpts.mkAttrsOf (with types; either str (listOf str)) { mappings = defaultNullOpts.mkAttrsOf (with types; either str (listOf str)) {
attach = "a"; attach = "a";
clear_marked = "M"; clear_marked = "M";
clear_target = "T"; clear_target = "T";
@ -151,60 +154,60 @@ with lib;
watch = "w"; watch = "w";
} "Buffer mappings for summary window."; } "Buffer mappings for summary window.";
open = helpers.defaultNullOpts.mkStr "botright vsplit | vertical resize 50" '' open = defaultNullOpts.mkStr "botright vsplit | vertical resize 50" ''
A command or function to open a window for the summary. A command or function to open a window for the summary.
Either a string or a function that returns an integer. Either a string or a function that returns an integer.
''; '';
}; };
output = { output = {
enabled = helpers.defaultNullOpts.mkBool true "Enable output."; enabled = defaultNullOpts.mkBool true "Enable output.";
open_on_run = helpers.defaultNullOpts.mkNullable (with types; either str bool) "short" '' open_on_run = defaultNullOpts.mkNullable (with types; either str bool) "short" ''
Open nearest test result after running. Open nearest test result after running.
''; '';
}; };
output_panel = { output_panel = {
enabled = helpers.defaultNullOpts.mkBool true "Enable output panel."; enabled = defaultNullOpts.mkBool true "Enable output panel.";
open = helpers.defaultNullOpts.mkStr "botright split | resize 15" '' open = defaultNullOpts.mkStr "botright split | resize 15" ''
A command or function to open a window for the output panel. A command or function to open a window for the output panel.
Either a string or a function that returns an integer. Either a string or a function that returns an integer.
''; '';
}; };
quickfix = { quickfix = {
enabled = helpers.defaultNullOpts.mkBool true "Enable quickfix."; enabled = defaultNullOpts.mkBool true "Enable quickfix.";
open = helpers.defaultNullOpts.mkNullable (with types; either bool str) false '' open = defaultNullOpts.mkNullable (with types; either bool str) false ''
Set to true to open quickfix on startup, or a function to be called when the quickfix Set to true to open quickfix on startup, or a function to be called when the quickfix
results are set. results are set.
''; '';
}; };
status = { status = {
enabled = helpers.defaultNullOpts.mkBool true "Enable status."; enabled = defaultNullOpts.mkBool true "Enable status.";
virtual_text = helpers.defaultNullOpts.mkBool false "Display status using virtual text."; virtual_text = defaultNullOpts.mkBool false "Display status using virtual text.";
signs = helpers.defaultNullOpts.mkBool true "Display status using signs."; signs = defaultNullOpts.mkBool true "Display status using signs.";
}; };
state = { state = {
enabled = helpers.defaultNullOpts.mkBool true "Enable state."; enabled = defaultNullOpts.mkBool true "Enable state.";
}; };
watch = { watch = {
enabled = helpers.defaultNullOpts.mkBool true "Enable watch."; enabled = defaultNullOpts.mkBool true "Enable watch.";
symbol_queries = helpers.mkNullOrOption (with helpers.nixvimTypes; attrsOf (maybeRaw str)) '' symbol_queries = mkNullOrOption (with types; attrsOf (maybeRaw str)) ''
Treesitter queries or functions to capture symbols that are used for querying the LSP Treesitter queries or functions to capture symbols that are used for querying the LSP
server for definitions to link files. server for definitions to link files.
If it is a function then the return value should be a list of node ranges. If it is a function then the return value should be a list of node ranges.
''; '';
filter_path = helpers.mkNullOrLuaFn '' filter_path = mkNullOrLuaFn ''
`(fun(path: string, root: string): boolean)` `(fun(path: string, root: string): boolean)`
Returns whether the watcher should inspect a path for dependencies. Returns whether the watcher should inspect a path for dependencies.
@ -213,9 +216,9 @@ with lib;
}; };
diagnostic = { diagnostic = {
enabled = helpers.defaultNullOpts.mkBool true "Enable diagnostic."; enabled = defaultNullOpts.mkBool true "Enable diagnostic.";
severity = helpers.defaultNullOpts.mkSeverity "error" '' severity = defaultNullOpts.mkSeverity "error" ''
Diagnostic severity, one of `vim.diagnostic.severity`. Diagnostic severity, one of `vim.diagnostic.severity`.
''; '';
}; };