mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

editorconfig: Migrate to builtin plugin (#335)

Browse source
This commit is contained in:
traxys 2023-04-15 15:21:25 +02:00 • committed by GitHub
parent 3797094d19
commit 121566a267
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 65 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

61
modules/editorconfig.nix Normal file
View file

@ -0,0 +1,61 @@
{
lib,
config,
...
}:
with lib; {
imports = [
(lib.mkRenamedOptionModule ["plugins" "editorconfig" "enable"] ["editorconfig" "enable"])
(lib.mkRemovedOptionModule ["plugins" "editorconfig" "package"] "editorconfig is now builtin, no plugin required")
];
options.editorconfig = {
enable = mkOption {
type = types.bool;
default = true;
description = "editorconfig plugin for neovim";
};
properties = mkOption {
type = types.attrsOf types.str;
default = {};
description = ''
The table key is a property name and the value is a callback function which accepts the
number of the buffer to be modified, the value of the property in the .editorconfig file,
and (optionally) a table containing all of the other properties and their values (useful
for properties which depend on other properties). The value is always a string and must be
coerced if necessary.
'';
example = {
foo = ''
function(bufnr, val, opts)
if opts.charset and opts.charset ~= "utf-8" then
error("foo can only be set when charset is utf-8", 0)
end
vim.b[bufnr].foo = val
end
'';
};
};
};
config = let
cfg = config.editorconfig;
in {
globals.editorconfig = mkIf (!cfg.enable) false;
extraConfigLua = let
mkProperty = name: function: ''
__editorconfig.properties.${name} = ${function}
'';
propertiesString = lib.concatLines (lib.mapAttrsToList mkProperty cfg.properties);
in
mkIf (propertiesString != "" && cfg.enable) ''
do
local __editorconfig = require('editorconfig')
${propertiesString}
end
'';
};
}

1
plugins/default.nix
View file

@ -68,7 +68,6 @@
./utils/comment-nvim.nix
./utils/commentary.nix
./utils/easyescape.nix
./utils/editorconfig.nix
./utils/endwise.nix
./utils/floaterm.nix
./utils/goyo.nix

59
plugins/utils/editorconfig.nix
View file

@ -1,59 +0,0 @@
{
lib,
config,
pkgs,
...
} @ args:
with lib; let
# TODO: Migrate to builtin editorconfig in neovim 0.9
helpers = import ../helpers.nix args;
in {
options.plugins.editorconfig = {
enable = mkEnableOption "editorconfig plugin for neovim";
package = helpers.mkPackageOption "editorconfig.nvim" pkgs.vimPlugins.editorconfig-nvim;
properties = mkOption {
type = types.attrsOf types.str;
default = {};
description = ''
The table key is a property name and the value is a callback function which accepts the
number of the buffer to be modified, the value of the property in the .editorconfig file,
and (optionally) a table containing all of the other properties and their values (useful
for properties which depend on other properties). The value is always a string and must be
coerced if necessary.
'';
example = {
foo = ''
function(bufnr, val, opts)
if opts.charset and opts.charset ~= "utf-8" then
error("foo can only be set when charset is utf-8", 0)
end
vim.b[bufnr].foo = val
end
'';
};
};
};
config = let
cfg = config.plugins.editorconfig;
in
mkIf cfg.enable {
extraPlugins = [cfg.package];
extraConfigLua = let
mkProperty = name: function: ''
__editorconfig.properties.${name} = ${function}
'';
propertiesString = lib.concatLines (lib.mapAttrsToList mkProperty cfg.properties);
in
mkIf (propertiesString != "" && cfg.enable) ''
do
local __editorconfig = require('editorconfig')
${propertiesString}
end
'';
};
}

9
tests/test-sources/plugins/utils/editorconfig.nix → tests/test-sources/modules/editorconfig.nix
View file

@ -1,12 +1,11 @@
{
# TODO: convert to disable test in neovim 0.9
empty = {
plugins.editorconfig.enable = true;
disable = {
editorconfig.enable = false;
};
example = {
plugins.editorconfig.enable = true;
plugins.editorconfig.properties.foo = ''
editorconfig.enable = true;
editorconfig.properties.foo = ''
function(bufnr, val, opts)
if opts.charset and opts.charset ~= "utf-8" then
error("foo can only be set when charset is utf-8", 0)