nix-community.nixvim/plugins/by-name/emmet/default.nix

{
  lib,
  ...
}:
let
  inherit (lib) types;
  inherit (lib.nixvim) defaultNullOpts mkNullOrOption;
in
lib.nixvim.plugins.mkVimPlugin {
  name = "emmet";
  packPathName = "emmet-vim";
  package = "emmet-vim";
  globalPrefix = "user_emmet_";

  maintainers = [ lib.maintainers.GaetanLepage ];

  # TODO introduced 2024-03-01: remove 2024-05-01
  deprecateExtraConfig = true;
  optionsRenamedToSettings = [
    "mode"
    {
      old = "leader";
      new = "leader_key";
    }
  ];

  settingsOptions = {
    mode = 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 = defaultNullOpts.mkStr "<C-y>" ''
      Leading keys to run Emmet functions.
    '';

    settings = 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>
          '';
        };
      };
    };
  };
}
added formatter + reformat existing codebase (#175) 2023-02-20 11:42:13 +01:00			`{`
			`lib,`
			`...`
helpers/vim-plugin/mkVimPlugin: refactor 2024-02-09 14:21:22 +01:00			`}:`
plugins/emmet: cosmetic refactoring 2025-01-22 07:57:18 +01:00			`let`
			`inherit (lib) types;`
			`inherit (lib.nixvim) defaultNullOpts mkNullOrOption;`
			`in`
			`lib.nixvim.plugins.mkVimPlugin {`
helpers/vim-plugin/mkVimPlugin: refactor 2024-02-09 14:21:22 +01:00			`name = "emmet";`
treewide: originalName -> packPathName We used to only think of it as the plugin repo's name, but we have been needing to use it for the name of the plugin's packpath location. 2024-12-13 08:27:14 -06:00			`packPathName = "emmet-vim";`
plugins: migrate `defaultPackage` -> `package` Migrate all users of `mkVimPlugin` and `mkNeovimPlugin` to use the new `package` argument instead of the old `defaultPackage` argument. 2024-09-02 14:05:11 +01:00			`package = "emmet-vim";`
helpers/vim-plugin/mkVimPlugin: refactor 2024-02-09 14:21:22 +01:00			`globalPrefix = "user_emmet_";`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00
plugins/emmet: cosmetic refactoring 2025-01-22 07:57:18 +01:00			`maintainers = [ lib.maintainers.GaetanLepage ];`
plugins: set myself (@GaetanLepage) as maintainer for several vim plugins 2024-03-04 09:35:28 +01:00
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`# TODO introduced 2024-03-01: remove 2024-05-01`
helpers/vim-plugin/mkVimPlugin: rename addExtraConfigRenameWarning to deprecateExtraConfig 2024-02-19 10:19:39 +01:00			`deprecateExtraConfig = true;`
plugins/*: use new mkSettingsRenamedOptionModules 2024-12-16 10:38:12 +01:00			`optionsRenamedToSettings = [`
			`"mode"`
			`{`
			`old = "leader";`
			`new = "leader_key";`
			`}`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`];`
dashboard.nvim, neogit, emmet: init plugins 2022-01-21 19:22:03 -04:00
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`settingsOptions = {`
plugins/emmet: cosmetic refactoring 2025-01-22 07:57:18 +01:00			`mode = defaultNullOpts.mkStr "a" ''`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`Choose modes, in which Emmet mappings will be created.`
			`Default value: 'a' - all modes.`
			`- 'n' - normal mode.`
			`- 'i' - insert mode.`
			`- 'v' - visual mode.`
dashboard.nvim, neogit, emmet: init plugins 2022-01-21 19:22:03 -04:00
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`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`
			`'';`

plugins/emmet: cosmetic refactoring 2025-01-22 07:57:18 +01:00			`leader_key = defaultNullOpts.mkStr "<C-y>" ''`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`Leading keys to run Emmet functions.`
			`'';`

plugins/emmet: cosmetic refactoring 2025-01-22 07:57:18 +01:00			`settings = mkNullOrOption (with types; attrsOf anything) ''`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`Emmet settings.`

			`Defaults: see https://github.com/mattn/emmet-vim/blob/master/autoload/emmet.vim`
			`'';`
			`};`
dashboard.nvim, neogit, emmet: init plugins 2022-01-21 19:22:03 -04:00
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`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;`
			`};`
			`};`
treewide: Reformat with nixfmt 2024-05-05 19:39:35 +02:00			`snippets = {`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`"html:5" = ''`
			`<!DOCTYPE html>`
			`<html lang=\"$\{lang}\">`
treewide: Reformat with nixfmt 2024-05-05 19:39:35 +02:00			`<head>`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`\t<meta charset=\"$\{charset}\">`
			`\t<title></title>`
			`\t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">`
treewide: Reformat with nixfmt 2024-05-05 19:39:35 +02:00			`</head>`
plugins/emmet: switch to settings option 2024-03-01 18:12:06 +01:00			`<body>\n\t$\{child}\|\n</body>`
treewide: Reformat with nixfmt 2024-05-05 19:39:35 +02:00			`</html>`
			`'';`
			`};`
added formatter + reformat existing codebase (#175) 2023-02-20 11:42:13 +01:00			`};`
helpers/vim-plugin/mkVimPlugin: refactor 2024-02-09 14:21:22 +01:00			`};`
treewide: Reformat with nixfmt 2024-05-05 19:39:35 +02:00			`};`
helpers/vim-plugin/mkVimPlugin: refactor 2024-02-09 14:21:22 +01:00			`}`