NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-04-03 11:31:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

session/nvim-session-manager: fix option descriptions; more explicit library inherits

Browse source
This commit is contained in:
raf 2025-03-04 23:30:52 +03:00
parent d12846211b
commit 27978c7186
No known key found for this signature in database
GPG key ID: 29D95B64378DB4BF
1 changed files with 58 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
modules/plugins/session/nvim-session-manager/nvim-session-manager.nix
View file

@ -1,7 +1,10 @@
{lib, ...}: let {lib, ...}: let
inherit (lib.types) nullOr str bool; inherit (lib.options) mkOption mkEnableOption;
inherit (lib.modules) mkRenamedOptionModule;
inherit (lib.strings) isString;
inherit (lib.types) nullOr str bool int enum listOf either;
inherit (lib.generators) mkLuaInline; inherit (lib.generators) mkLuaInline;
inherit (lib) mkEnableOption mkOption types mkRenamedOptionModule; inherit (lib.nvim.types) luaInline mkPluginSetupOption;
in { in {
imports = let imports = let
renameSetupOpt = oldPath: newPath: renameSetupOpt = oldPath: newPath:
@ -51,70 +54,100 @@ in {
usePicker = mkOption { usePicker = mkOption {
type = bool; type = bool;
default = true; default = true;
description = "Whether or not we should use dressing.nvim to build a session picker UI"; description = ''
Whether we should use `dressing.nvim` to build a session picker UI
'';
}; };
setupOpts = { setupOpts = mkPluginSetupOption "which-key" {
path_replacer = mkOption { path_replacer = mkOption {
type = types.str; type = str;
default = "__"; default = "__";
description = "The character to which the path separator will be replaced for session files"; description = ''
The character to which the path separator will be replaced for session files
'';
}; };
colon_replacer = mkOption { colon_replacer = mkOption {
type = types.str; type = str;
default = "++"; default = "++";
description = "The character to which the colon symbol will be replaced for session files"; description = ''
The character to which the colon symbol will be replaced for session files
'';
}; };
autoload_mode = mkOption { autoload_mode = mkOption {
type = types.enum ["Disabled" "CurrentDir" "LastSession"]; type = either (enum ["Disabled" "CurrentDir" "LastSession"]) luaInline;
# variable `sm` referenced from ./config.nix # Variable 'sm' is defined in the pluginRC of nvim-session-manager. The
apply = value: mkLuaInline "sm.AutoloadMode.${value}"; # definition is as follows: `local sm = require('session_manager.config')`
apply = val:
if isString val
then mkLuaInline "sm.AutoloadMode.${val}"
else val;
default = "LastSession"; default = "LastSession";
description = "Define what to do when Neovim is started without arguments. Possible values: Disabled, CurrentDir, LastSession"; description = ''
Define what to do when Neovim is started without arguments.
Takes either one of `"Disabled"`, `"CurrentDir"`, `"LastSession` in which case the value
will be inserted into `sm.AutoloadMode.<value>`, or an inline Lua value.
'';
}; };
max_path_length = mkOption { max_path_length = mkOption {
type = types.nullOr types.int; type = nullOr int;
default = 80; default = 80;
description = "Shorten the display path if length exceeds this threshold. Use 0 if don't want to shorten the path at all"; description = ''
Shorten the display path if length exceeds this threshold.
Use `0` if don't want to shorten the path at all
'';
}; };
autosave_last_session = mkOption { autosave_last_session = mkOption {
type = types.bool; type = bool;
default = true; default = true;
description = "Automatically save last session on exit and on session switch"; description = ''
Automatically save last session on exit and on session switch
'';
}; };
autosave_ignore_not_normal = mkOption { autosave_ignore_not_normal = mkOption {
type = types.bool; type = bool;
default = true; default = true;
description = "Plugin will not save a session when no buffers are opened, or all of them aren't writable or listed"; description = ''
Plugin will not save a session when no buffers are opened, or all of them are
not writable or listed
'';
}; };
autosave_ignore_dirs = mkOption { autosave_ignore_dirs = mkOption {
type = types.listOf types.str; type = listOf str;
default = []; default = [];
description = "A list of directories where the session will not be autosaved"; description = "A list of directories where the session will not be autosaved";
}; };
autosave_ignore_filetypes = mkOption { autosave_ignore_filetypes = mkOption {
type = types.listOf types.str; type = listOf str;
default = ["gitcommit"]; default = ["gitcommit"];
description = "All buffers of these file types will be closed before the session is saved"; description = ''
All buffers of these file types will be closed before the session is saved
'';
}; };
autosave_ignore_buftypes = mkOption { autosave_ignore_buftypes = mkOption {
type = types.listOf types.str; type = listOf str;
default = []; default = [];
description = "All buffers of these buffer types will be closed before the session is saved"; description = ''
All buffers of these buffer types will be closed before the session is saved
'';
}; };
autosave_only_in_session = mkOption { autosave_only_in_session = mkOption {
type = types.bool; type = bool;
default = false; default = false;
description = "Always autosaves session. If true, only autosaves after a session is active"; description = ''
Always autosaves session. If `true`, only autosaves after a session is active
'';
}; };
}; };
}; };