plugins/utils: move to by-name

2025-07-13 10:44:34 +02:00 · 2024-09-04 17:14:16 +01:00 · 2024-09-04 17:14:16 +01:00 · 52f125679f
commit 52f125679f
parent faff32b9f1
195 changed files with 2 additions and 102 deletions
--- a/plugins/by-name/emmet/default.nix
+++ b/plugins/by-name/emmet/default.nix
@ -0,0 +1,95 @@
+{
+  lib,
+  helpers,
+  ...
+}:
+with lib;
+with helpers.vim-plugin;
+mkVimPlugin {
+  name = "emmet";
+  originalName = "emmet-vim";
+  package = "emmet-vim";
+  globalPrefix = "user_emmet_";
+
+  maintainers = [ maintainers.GaetanLepage ];
+
+  # TODO introduced 2024-03-01: remove 2024-05-01
+  deprecateExtraConfig = true;
+  optionsRenamedToSettings = [ "mode" ];
+  imports = [
+    (mkRenamedOptionModule
+      [
+        "plugins"
+        "emmet"
+        "leader"
+      ]
+      [
+        "plugins"
+        "emmet"
+        "settings"
+        "leader_key"
+      ]
+    )
+  ];
+
+  settingsOptions = {
+    mode = helpers.defaultNullOpts.mkStr "a" ''
+      Choose modes, in which Emmet mappings will be created.
+      Default value: 'a' - all modes.
+      - 'n' - normal mode.
+      - 'i' - insert mode.
+      - 'v' - visual mode.
+
+      Examples:
+      - create Emmet mappings only for normal mode: `n`
+      - create Emmet mappings for insert, normal and visual modes: `inv`
+      - create Emmet mappings for all modes: `a`
+    '';
+
+    leader_key = helpers.defaultNullOpts.mkStr "<C-y>" ''
+      Leading keys to run Emmet functions.
+    '';
+
+    settings = helpers.mkNullOrOption (with types; attrsOf anything) ''
+      Emmet settings.
+
+      Defaults: see https://github.com/mattn/emmet-vim/blob/master/autoload/emmet.vim
+    '';
+  };
+
+  settingsExample = {
+    mode = "inv";
+    leader = "<C-Z>";
+    settings = {
+      variables = {
+        lang = "ja";
+      };
+      html = {
+        default_attributes = {
+          option = {
+            value = null;
+          };
+          textarea = {
+            id = null;
+            name = null;
+            cols = 10;
+            rows = 10;
+          };
+        };
+        snippets = {
+          "html:5" = ''
+            <!DOCTYPE html>
+            <html lang=\"$\{lang}\">
+            <head>
+            \t<meta charset=\"$\{charset}\">
+            \t<title></title>
+            \t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">
+            </head>
+            <body>\n\t$\{child}|\n</body>
+            </html>
+          '';
+        };
+      };
+    };
+  };
+}