mirror of
https://github.com/nix-community/nixvim.git
synced 2025-07-04 22:34:31 +02:00
plugins/neorg: switch to mkNeovimPlugin
This commit is contained in:
Gaetan Lepage
nix-infra-bot
parent
c0550513b3
commit
2b5a4a3896
3 changed files with 296 additions and 197 deletions
|
|
@ -1,110 +1,195 @@
|
|||
{
|
||||
lib,
|
||||
helpers,
|
||||
config,
|
||||
pkgs,
|
||||
...
|
||||
}:
|
||||
let
|
||||
cfg = config.plugins.neorg;
|
||||
inherit (lib.nixvim)
|
||||
defaultNullOpts
|
||||
mkNullOrStr
|
||||
mkNullOrOption
|
||||
mkNullOrOption'
|
||||
;
|
||||
inherit (lib) types;
|
||||
in
|
||||
with lib;
|
||||
{
|
||||
options.plugins.neorg = helpers.neovim-plugin.extraOptionsOptions // {
|
||||
enable = mkEnableOption "neorg";
|
||||
lib.nixvim.neovim-plugin.mkNeovimPlugin {
|
||||
name = "neorg";
|
||||
|
||||
package = lib.mkPackageOption pkgs "neorg" {
|
||||
maintainers = [ lib.maintainers.GaetanLepage ];
|
||||
|
||||
# TODO introduced 2024-12-12: remove after 25.05
|
||||
deprecateExtraOptions = true;
|
||||
optionsRenamedToSettings = [
|
||||
"lazyLoading"
|
||||
[
|
||||
"logger"
|
||||
"plugin"
|
||||
]
|
||||
[
|
||||
"logger"
|
||||
"useConsole"
|
||||
]
|
||||
[
|
||||
"logger"
|
||||
"highlights"
|
||||
]
|
||||
[
|
||||
"logger"
|
||||
"useFile"
|
||||
]
|
||||
[
|
||||
"logger"
|
||||
"level"
|
||||
]
|
||||
[
|
||||
"logger"
|
||||
"floatPrecision"
|
||||
]
|
||||
];
|
||||
imports = [
|
||||
./deprecations.nix
|
||||
];
|
||||
|
||||
extraOptions = {
|
||||
telescopeIntegration = {
|
||||
enable = lib.mkEnableOption "`neorg-telescope` plugin for telescope integration.";
|
||||
|
||||
package = lib.mkPackageOption pkgs "neorg-telescope" {
|
||||
default = [
|
||||
"vimPlugins"
|
||||
"neorg"
|
||||
"neorg-telescope"
|
||||
];
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
settingsOptions = {
|
||||
hook = mkNullOrOption types.rawLua ''
|
||||
A user-defined function that is invoked whenever Neorg starts up. May be used to e.g. set custom keybindings.
|
||||
|
||||
```lua
|
||||
fun(manual: boolean, arguments?: string)
|
||||
```
|
||||
'';
|
||||
|
||||
lazy_loading = defaultNullOpts.mkBool false ''
|
||||
Whether to defer loading the Neorg core until after the user has entered a `.norg` file.
|
||||
'';
|
||||
|
||||
load = defaultNullOpts.mkAttrsOf' {
|
||||
description = ''
|
||||
A list of modules to load, alongside their configurations.
|
||||
'';
|
||||
example = {
|
||||
"core.defaults".__empty = null;
|
||||
"core.concealer".config = {
|
||||
icon_preset = "varied";
|
||||
};
|
||||
"core.dirman".config = {
|
||||
workspaces = {
|
||||
work = "~/notes/work";
|
||||
home = "~/notes/home";
|
||||
};
|
||||
};
|
||||
};
|
||||
pluginDefault = { };
|
||||
type = types.anything;
|
||||
};
|
||||
|
||||
logger = {
|
||||
plugin = defaultNullOpts.mkStr "neorg" ''
|
||||
Name of the plugin.
|
||||
Prepended to log messages.
|
||||
'';
|
||||
|
||||
use_console = defaultNullOpts.mkBool true ''
|
||||
Whether to print the output to Neovim while running.
|
||||
'';
|
||||
|
||||
highlights = defaultNullOpts.mkBool true ''
|
||||
Whether highlighting should be used in console (using `:echohl`).
|
||||
'';
|
||||
|
||||
use_file = defaultNullOpts.mkBool true ''
|
||||
Whether to write output to a file.
|
||||
'';
|
||||
|
||||
level = defaultNullOpts.mkStr "warn" ''
|
||||
Any messages above this level will be logged.
|
||||
'';
|
||||
|
||||
modes = defaultNullOpts.mkListOf' {
|
||||
description = ''
|
||||
Level configuration.
|
||||
'';
|
||||
type = types.submodule {
|
||||
freeformType = with types; attrsOf anything;
|
||||
options = {
|
||||
name = mkNullOrStr ''
|
||||
Name for this log level.
|
||||
'';
|
||||
|
||||
hl = mkNullOrStr ''
|
||||
highlight group.
|
||||
'';
|
||||
|
||||
level = mkNullOrOption' {
|
||||
type = with types; maybeRaw (either ints.unsigned str);
|
||||
description = ''
|
||||
Log level value.
|
||||
'';
|
||||
example.__raw = "vim.log.levels.TRACE";
|
||||
};
|
||||
};
|
||||
};
|
||||
pluginDefault = [
|
||||
{
|
||||
name = "trace";
|
||||
hl = "Comment";
|
||||
level.__raw = "vim.log.levels.TRACE";
|
||||
}
|
||||
{
|
||||
name = "debug";
|
||||
hl = "Comment";
|
||||
level.__raw = "vim.log.levels.DEBUG";
|
||||
}
|
||||
{
|
||||
name = "info";
|
||||
hl = "None";
|
||||
level.__raw = "vim.log.levels.INFO";
|
||||
}
|
||||
{
|
||||
name = "warn";
|
||||
hl = "WarningMsg";
|
||||
level.__raw = "vim.log.levels.WARN";
|
||||
}
|
||||
{
|
||||
name = "error";
|
||||
hl = "ErrorMsg";
|
||||
level.__raw = "vim.log.levels.ERROR";
|
||||
}
|
||||
{
|
||||
name = "fatal";
|
||||
hl = "ErrorMsg";
|
||||
level = 5;
|
||||
}
|
||||
];
|
||||
};
|
||||
|
||||
neorgTelescopePackage = lib.mkPackageOption pkgs [
|
||||
"vimPlugins"
|
||||
"neorg-telescope"
|
||||
] { nullable = true; };
|
||||
|
||||
lazyLoading = helpers.defaultNullOpts.mkBool false '''';
|
||||
|
||||
logger =
|
||||
let
|
||||
modes = {
|
||||
trace = {
|
||||
hl = "Comment";
|
||||
level = "trace";
|
||||
};
|
||||
debug = {
|
||||
hl = "Comment";
|
||||
level = "debug";
|
||||
};
|
||||
info = {
|
||||
hl = "None";
|
||||
level = "info";
|
||||
};
|
||||
warn = {
|
||||
hl = "WarningMsg";
|
||||
level = "warn";
|
||||
};
|
||||
error = {
|
||||
hl = "ErrorMsg";
|
||||
level = "error";
|
||||
};
|
||||
fatal = {
|
||||
hl = "ErrorMsg";
|
||||
level = 5;
|
||||
};
|
||||
};
|
||||
in
|
||||
{
|
||||
plugin = helpers.defaultNullOpts.mkStr "neorg" ''
|
||||
Name of the plugin. Prepended to log messages
|
||||
'';
|
||||
|
||||
useConsole = helpers.defaultNullOpts.mkBool true ''
|
||||
Should print the output to neovim while running
|
||||
'';
|
||||
|
||||
highlights = helpers.defaultNullOpts.mkBool true ''
|
||||
Should highlighting be used in console (using echohl)
|
||||
'';
|
||||
|
||||
useFile = helpers.defaultNullOpts.mkBool true ''
|
||||
Should write to a file
|
||||
'';
|
||||
|
||||
level = helpers.defaultNullOpts.mkEnum (attrNames modes) "warn" ''
|
||||
Any messages above this level will be logged
|
||||
'';
|
||||
|
||||
modes = mapAttrs (
|
||||
mode: defaults:
|
||||
helpers.mkCompositeOption "Settings for mode ${mode}." {
|
||||
hl = helpers.defaultNullOpts.mkStr defaults.hl ''
|
||||
Highlight for mode ${mode}.
|
||||
'';
|
||||
|
||||
level = helpers.defaultNullOpts.mkLogLevel defaults.level ''
|
||||
Level for mode ${mode}.
|
||||
'';
|
||||
}
|
||||
) modes;
|
||||
|
||||
floatPrecision = helpers.defaultNullOpts.mkNullable types.float 1.0e-2 ''
|
||||
Can limit the number of decimals displayed for floats
|
||||
float_precision = defaultNullOpts.mkNullable types.float 0.01 ''
|
||||
Can limit the number of decimals displayed for floats.
|
||||
'';
|
||||
};
|
||||
|
||||
modules = mkOption {
|
||||
type = with types; attrsOf attrs;
|
||||
description = "Modules configuration.";
|
||||
default = { };
|
||||
example = {
|
||||
"core.defaults" = {
|
||||
__empty = null;
|
||||
};
|
||||
"core.dirman" = {
|
||||
config = {
|
||||
|
||||
settingsExample = {
|
||||
load = {
|
||||
"core.defaults".__empty = null;
|
||||
"core.concealer".config = {
|
||||
icon_preset = "varied";
|
||||
};
|
||||
"core.dirman".config = {
|
||||
workspaces = {
|
||||
work = "~/notes/work";
|
||||
home = "~/notes/home";
|
||||
|
|
@ -112,62 +197,26 @@ with lib;
|
|||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
config =
|
||||
let
|
||||
setupOptions =
|
||||
with cfg;
|
||||
{
|
||||
lazy_loading = lazyLoading;
|
||||
extraConfig = cfg: {
|
||||
|
||||
logger = with logger; {
|
||||
inherit plugin;
|
||||
use_console = useConsole;
|
||||
inherit highlights;
|
||||
use_file = useFile;
|
||||
inherit level;
|
||||
extraPlugins = lib.mkIf cfg.telescopeIntegration.enable [ cfg.telescopeIntegration.package ];
|
||||
|
||||
modes = filter (v: v != null) (
|
||||
mapAttrsToList (
|
||||
mode: modeConfig:
|
||||
helpers.ifNonNull' modeConfig {
|
||||
name = mode;
|
||||
inherit (modeConfig) hl level;
|
||||
}
|
||||
) modes
|
||||
);
|
||||
float_precision = floatPrecision;
|
||||
};
|
||||
|
||||
load = modules;
|
||||
}
|
||||
// cfg.extraOptions;
|
||||
|
||||
telescopeSupport = hasAttr "core.integrations.telescope" cfg.modules;
|
||||
in
|
||||
mkIf cfg.enable {
|
||||
warnings =
|
||||
(optional (telescopeSupport && (!config.plugins.telescope.enable)) ''
|
||||
Telescope support for neorg (`core.integrations.telescope`) is enabled but the
|
||||
telescope plugin is not.
|
||||
let
|
||||
modules = cfg.settings.load or { };
|
||||
telescopeModuleEnabled = (modules."core.integrations.telescope" or null) != null;
|
||||
in
|
||||
(lib.optional (telescopeModuleEnabled && (!cfg.telescopeIntegration.enable)) ''
|
||||
You have enabled the telescope neorg module (`core.integrations.telescope`) but have not enabled `plugins.neorg.telescopeIntegration.enable`.
|
||||
The latter will install the `neorg-telescope` plugin necessary for this integration to work.
|
||||
'')
|
||||
++ (optional (telescopeSupport && (cfg.neorgTelescopePackage == null)) ''
|
||||
Telescope support for neorg (`core.integrations.telescope`) is enabled but the
|
||||
`neorgTelescopePackage` package is not set.
|
||||
++ (lib.optional (cfg.telescopeIntegration.enable && (!config.plugins.telescope.enable)) ''
|
||||
Telescope support for neorg is enabled but the telescope plugin is not.
|
||||
'')
|
||||
++ (optional ((hasAttr "core.defaults" cfg.modules) && (!config.plugins.treesitter.enable)) ''
|
||||
++ (lib.optional ((modules ? "core.defaults") && (!config.plugins.treesitter.enable)) ''
|
||||
Neorg's `core.defaults` module is enabled but `plugins.treesitter` is not.
|
||||
Treesitter is required when using the `core.defaults`.
|
||||
'');
|
||||
|
||||
extraPlugins = [
|
||||
cfg.package
|
||||
] ++ (optional (telescopeSupport && cfg.neorgTelescopePackage != null) cfg.neorgTelescopePackage);
|
||||
|
||||
extraConfigLua = ''
|
||||
require('neorg').setup(${helpers.toLuaObject setupOptions})
|
||||
'';
|
||||
};
|
||||
}
|
||||
|
|
|
|||
32
plugins/by-name/neorg/deprecations.nix
Normal file
32
plugins/by-name/neorg/deprecations.nix
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
{ lib, ... }:
|
||||
let
|
||||
basePluginPath = [
|
||||
"plugins"
|
||||
"neorg"
|
||||
];
|
||||
in
|
||||
{
|
||||
imports = [
|
||||
(lib.mkRenamedOptionModule (basePluginPath ++ [ "modules" ]) (
|
||||
basePluginPath
|
||||
++ [
|
||||
"settings"
|
||||
"load"
|
||||
]
|
||||
))
|
||||
(lib.mkRemovedOptionModule (
|
||||
basePluginPath
|
||||
++ [
|
||||
"logger"
|
||||
"modes"
|
||||
]
|
||||
) "Please use `settings.logger.modes` but you now need to provide a list of submodules.")
|
||||
(lib.mkRenamedOptionModule (basePluginPath ++ [ "neorgTelescopePackage" ]) (
|
||||
basePluginPath
|
||||
++ [
|
||||
"telescopeIntegration"
|
||||
"package"
|
||||
]
|
||||
))
|
||||
];
|
||||
}
|
||||
|
|
@ -5,56 +5,83 @@
|
|||
plugins.neorg.enable = true;
|
||||
};
|
||||
|
||||
example = {
|
||||
defaults = {
|
||||
plugins = {
|
||||
|
||||
# Treesitter is required when using the "core.defaults" module.
|
||||
treesitter.enable = true;
|
||||
|
||||
neorg = {
|
||||
enable = true;
|
||||
|
||||
lazyLoading = false;
|
||||
settings = {
|
||||
hook = null;
|
||||
lazy_loading = false;
|
||||
load = { };
|
||||
logger = {
|
||||
plugin = "neorg";
|
||||
useConsole = true;
|
||||
use_console = true;
|
||||
highlights = true;
|
||||
useFile = true;
|
||||
use_file = true;
|
||||
level = "warn";
|
||||
modes = {
|
||||
trace = {
|
||||
modes = [
|
||||
{
|
||||
name = "trace";
|
||||
hl = "Comment";
|
||||
level = "trace";
|
||||
};
|
||||
debug = {
|
||||
level.__raw = "vim.log.levels.TRACE";
|
||||
}
|
||||
{
|
||||
name = "debug";
|
||||
hl = "Comment";
|
||||
level = "debug";
|
||||
};
|
||||
info = {
|
||||
level.__raw = "vim.log.levels.DEBUG";
|
||||
}
|
||||
{
|
||||
name = "info";
|
||||
hl = "None";
|
||||
level = "info";
|
||||
};
|
||||
warn = {
|
||||
level.__raw = "vim.log.levels.INFO";
|
||||
}
|
||||
{
|
||||
name = "warn";
|
||||
hl = "WarningMsg";
|
||||
level = "warn";
|
||||
};
|
||||
error = {
|
||||
level.__raw = "vim.log.levels.WARN";
|
||||
}
|
||||
{
|
||||
name = "error";
|
||||
hl = "ErrorMsg";
|
||||
level = "error";
|
||||
};
|
||||
fatal = {
|
||||
level.__raw = "vim.log.levels.ERROR";
|
||||
}
|
||||
{
|
||||
name = "fatal";
|
||||
hl = "ErrorMsg";
|
||||
level = 5;
|
||||
}
|
||||
];
|
||||
|
||||
float_precision = 0.01;
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
floatPrecision = 1.0e-2;
|
||||
};
|
||||
|
||||
modules = {
|
||||
"core.defaults" = {
|
||||
__empty = null;
|
||||
example = {
|
||||
plugins = {
|
||||
|
||||
# Treesitter is required when using the "core.defaults" module.
|
||||
treesitter.enable = true;
|
||||
|
||||
neorg = {
|
||||
enable = true;
|
||||
|
||||
settings = {
|
||||
lazy_loading = true;
|
||||
|
||||
load = {
|
||||
"core.defaults".__empty = null;
|
||||
"core.concealer".config = {
|
||||
icon_preset = "varied";
|
||||
};
|
||||
"core.dirman" = {
|
||||
config = {
|
||||
"core.dirman".config = {
|
||||
workspaces = {
|
||||
work = "~/notes/work";
|
||||
home = "~/notes/home";
|
||||
|
|
@ -74,20 +101,11 @@
|
|||
|
||||
neorg = {
|
||||
enable = true;
|
||||
modules."core.integrations.telescope".__empty = null;
|
||||
settings.load."core.integrations.telescope".__empty = null;
|
||||
telescopeIntegration.enable = true;
|
||||
};
|
||||
|
||||
web-devicons.enable = true;
|
||||
};
|
||||
};
|
||||
|
||||
no-packages = {
|
||||
# Treesitter is required when using the "core.defaults" module.
|
||||
plugins.treesitter.enable = true;
|
||||
|
||||
plugins.neorg = {
|
||||
enable = true;
|
||||
neorgTelescopePackage = null;
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue