Merge 7d077f43f7 into 7b719d0044

languages/ts: add `ts-error-translator.nvim` as an extension plugin

docs/release-notes/rl-0.7.md

@@ -15,15 +15,27 @@ Release notes for release 0.7
   [](#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides) from
   `anything` to a `submodule` for better type checking.
 - Fix null `vim.lsp.mappings` generating an error and not being filtered out.
-- Add basic transparency support for `oxocarbon` theme by setting the
-  highlight group for `Normal`, `NormalFloat`, `LineNr`, `SignColumn` and
-  optionally `NvimTreeNormal` to `none`.
+- Add basic transparency support for `oxocarbon` theme by setting the highlight
+  group for `Normal`, `NormalFloat`, `LineNr`, `SignColumn` and optionally
+  `NvimTreeNormal` to `none`.
 
 [horriblename](https://github.com/horriblename):
 
 - Fix broken treesitter-context keybinds in visual mode
-- Depcrecate use of `__empty` to define empty tables in lua. Empty attrset are
-  no longer filtered and thus should be used instead.
+- Deprecate use of `__empty` to define empty tables in lua. Empty attrset are no
+  longer filtered and thus should be used instead.
+
+[jacekpoz](https://github.com/jacekpoz):
+
+- Add [ocaml-lsp](https://github.com/ocaml/ocaml-lsp) support.
+
+- Fix Emac typo
+
+[diniamo](https://github.com/diniamo):
+
+- Move the `theme` dag entry to before `luaScript`.
+
+- Add rustfmt as the default formatter for Rust
 
 [NotAShelf](https://github.com/notashelf)
 
@@ -39,13 +51,12 @@ Release notes for release 0.7
   added once the [credo](https://github.com/rrrene/credo) linter has been added
   to nixpkgs. A pull request is currently open.
 
-- Remove vim-tidal and friends
+- Remove vim-tidal and friends.
 
 - Clean up Lualine module to reduce theme dependency on Catppuccin, and fixed
   blending issues in component separators.
 
-[jacekpoz](https://github.com/jacekpoz):
-
-- Add [ocaml-lsp](https://github.com/ocaml/ocaml-lsp) support.
-
-- Fix Emac typo
+- Add
+  [ts-error-translator.nvim](https://github.com/dmmulroy/ts-error-translator.nvim)
+  extension of the TS language module, under
+  `vim.languages.ts.extensions.ts-error-translator`

flake.lock

@@ -1597,6 +1597,22 @@
         "type": "github"
       }
     },
+    "plugin-ts-error-translator": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1712269172,
+        "narHash": "sha256-NJ0qfKvkwZ/0GolAeATlQLyQ7nGN6Z6q3uRqI+73wPk=",
+        "owner": "dmmulroy",
+        "repo": "ts-error-translator.nvim",
+        "rev": "11ae55b28bde02663b5f983f59b0e3fd9c4e845b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "dmmulroy",
+        "repo": "ts-error-translator.nvim",
+        "type": "github"
+      }
+    },
     "plugin-vim-dirtytalk": {
       "flake": false,
       "locked": {
@@ -1840,6 +1856,7 @@
         "plugin-toggleterm-nvim": "plugin-toggleterm-nvim",
         "plugin-tokyonight": "plugin-tokyonight",
         "plugin-trouble": "plugin-trouble",
+        "plugin-ts-error-translator": "plugin-ts-error-translator",
         "plugin-vim-dirtytalk": "plugin-vim-dirtytalk",
         "plugin-vim-fugitive": "plugin-vim-fugitive",
         "plugin-vim-illuminate": "plugin-vim-illuminate",

flake.nix

@@ -183,6 +183,11 @@
       flake = false;
     };
 
+    plugin-ts-error-translator = {
+      url = "github:dmmulroy/ts-error-translator.nvim";
+      flake = false;
+    };
+
     # Copying/Registers
     plugin-registers = {
       url = "github:tversteeg/registers.nvim";

modules/modules.nix

@@ -10,6 +10,7 @@
   # Contains configuration for core neovim features
   # such as spellchecking, mappings, and the init script (init.vim).
   neovim = map (p: ./neovim + "/${p}") [
+    "global"
     "init"
     "mappings"
   ];

modules/neovim/global/default.nix

@@ -0,0 +1,12 @@
+{lib, ...}: let
+  inherit (lib.lists) concatLists;
+  inherit (lib.filesystem) listFilesRecursive;
+in {
+  imports = concatLists [
+    # Configuration options for Neovim UI
+    (listFilesRecursive ./ui)
+
+    # vim.diagnostics
+    [./diagnostics.nix]
+  ];
+}

modules/neovim/global/diagnostics.nix

@@ -0,0 +1,115 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.types) str bool enum either;
+in {
+  options.vim.diagnostics = {
+    virtual_text = mkOption {
+      type = bool;
+      default = true;
+      description = ''
+        Whether to use virtual text for diagnostics.
+
+        If multiple diagnostics are set for a namespace, one
+        prefix per diagnostic + the last diagnostic message
+        are shown.
+      '';
+    };
+
+    update_in_insert = mkOption {
+      type = bool;
+      default = false;
+      description = ''
+        Whether to update diagnostics in insert mode.
+
+        This is useful for slow diagnostics sources, but can
+        also cause lag in insert mode.
+      '';
+    };
+
+    underline = mkOption {
+      type = bool;
+      default = true;
+      description = ''
+        Whether to underline diagnostics.
+      '';
+    };
+
+    severity_sort = mkOption {
+      type = bool;
+      default = false;
+      description = ''
+        Whether to sort diagnostics by severity.
+
+        This affects the order in which signs and
+        virtual text are displayed. When true, higher
+        severities are displayed before lower severities (e.g.
+        ERROR is displayed before WARN)
+      '';
+    };
+
+    float = {
+      focusable = mkOption {
+        type = bool;
+        default = false;
+        description = ''
+          Whether the floating window is focusable.
+          When true, the floating window can be focused and
+          interacted with. When false, the floating window is
+          not focusable and will not receive input.
+        '';
+      };
+
+      border = mkOption {
+        type = enum ["none" "single" "double" "rounded" "solid" "shadow"];
+        default = config.vim.ui.border.globalStyle;
+        description = ''
+          The border style of the floating window.
+
+          Possible values:
+            - none
+            - single
+            - double
+            - rounded
+            - solid
+            - shadow
+
+          See `:h nvim_open_win` for the available border
+          styles and their definitions.
+        '';
+      };
+
+      source = mkOption {
+        type = either bool (enum ["always" "if_many"]);
+        default = "auto";
+        description = ''
+            The source of the floating window.
+            Possible values:
+          - auto: Use the same source as the diagnostics
+            window.
+          - window: Use the window source.
+          - buffer: Use the buffer source.
+        '';
+      };
+
+      prefix = mkOption {
+        type = str;
+        default = "";
+        description = ''
+          Prefix string for each diagnostic in the floating window
+        '';
+      };
+
+      suffix = mkOption {
+        type = str;
+        default = "";
+        description = ''
+          Suffix string for each diagnostic in the floating window
+        '';
+      };
+    };
+  };
+}

modules/neovim/global/ui/borders.nix

@@ -0,0 +1,51 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.attrsets) mapAttrs;
+  inherit (lib.lists) optionals;
+  inherit (lib.types) enum;
+
+  cfg = config.vim.ui.borders;
+
+  # See `:h nvim_open_win` for the available border styles
+  # this list can be updated if additional styles are added.
+  defaultStyles = ["none" "single" "double" "rounded" "solid" "shadow"];
+in {
+  options.vim.ui.borders = {
+    enable = mkEnableOption "visible borders for windows that support configurable borders";
+
+    # TODO: support configurable border elements with a lua table converted from a list of str
+    # e.g. [ "╔" "═" "╗" "║" "╝" "═" "╚" "║" ]
+    globalStyle = mkOption {
+      type = enum defaultStyles;
+      default = "single";
+      description = ''
+        The global border style to use.
+      '';
+    };
+
+    plugins = let
+      mkPluginStyleOption = name: {
+        enable = mkEnableOption "borders for the ${name} plugin" // {default = cfg.enable;};
+
+        style = mkOption {
+          type = enum (defaultStyles ++ optionals (name != "which-key") ["shadow"]);
+          default = cfg.globalStyle;
+          description = "The border style to use for the ${name} plugin";
+        };
+      };
+    in
+      mapAttrs (_: mkPluginStyleOption) {
+        # despite not having it listed in example configuration, which-key does support the rounded type
+        # additionally, it supports a "shadow" type that is similar to none but is of higher contrast
+        which-key = "which-key";
+        lspsaga = "lspsaga";
+        nvim-cmp = "nvim-cmp";
+        lsp-signature = "lsp-signature";
+        code-action-menu = "code-actions-menu";
+      };
+  };
+}

modules/neovim/global/ui/icons.nix

@@ -0,0 +1,32 @@
+{lib, ...}: let
+  inherit (lib.options) mkOption;
+  inherit (lib.types) str;
+in {
+  options.vim.ui.icons = {
+    diagnostics = {
+      ERROR = mkOption {
+        type = str;
+        default = " ";
+        description = "The icon to use for error messages";
+      };
+
+      WARN = mkOption {
+        type = str;
+        default = " ";
+        description = "The icon to use for warning messages";
+      };
+
+      INFO = mkOption {
+        type = str;
+        default = " ";
+        description = "The icon to use for info messages";
+      };
+
+      HINT = mkOption {
+        type = str;
+        default = " ";
+        description = "The icon to use for hint messages";
+      };
+    };
+  };
+}

modules/plugins/languages/rust.nix

@@ -4,17 +4,33 @@
   lib,
   ...
 }: let
+  inherit (builtins) attrNames;
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.options) mkOption mkEnableOption;
   inherit (lib.strings) optionalString;
   inherit (lib.trivial) boolToString;
   inherit (lib.lists) isList optionals;
-  inherit (lib.types) bool package str listOf either;
+  inherit (lib.types) bool package str listOf either enum;
   inherit (lib.nvim.types) mkGrammarOption;
   inherit (lib.nvim.lua) expToLua;
   inherit (lib.nvim.dag) entryAnywhere;
 
   cfg = config.vim.languages.rust;
+
+  defaultFormat = "rustfmt";
+  formats = {
+    rustfmt = {
+      package = pkgs.rustfmt;
+      nullConfig = ''
+        table.insert(
+          ls_sources,
+          null_ls.builtins.formatting.rustfmt.with({
+            command = "${cfg.format.package}/bin/rustfmt",
+          })
+        )
+      '';
+    };
+  };
 in {
   options.vim.languages.rust = {
     enable = mkEnableOption "Rust language support";
@@ -49,6 +65,22 @@ in {
       };
     };
 
+    format = {
+      enable = mkEnableOption "Rust formatting" // {default = config.vim.languages.enableFormat;};
+
+      type = mkOption {
+        description = "Rust formatter to use";
+        type = enum (attrNames formats);
+        default = defaultFormat;
+      };
+
+      package = mkOption {
+        description = "Rust formatter package";
+        type = package;
+        default = formats.${cfg.format.type}.package;
+      };
+    };
+
     dap = {
       enable = mkOption {
         description = "Rust Debug Adapter support";
@@ -86,6 +118,11 @@ in {
       vim.treesitter.grammars = [cfg.treesitter.package];
     })
 
+    (mkIf cfg.format.enable {
+      vim.lsp.null-ls.enable = true;
+      vim.lsp.null-ls.sources.rust-format = formats.${cfg.format.type}.nullConfig;
+    })
+
     (mkIf (cfg.lsp.enable || cfg.dap.enable) {
       vim = {
         startPlugins = ["rust-tools"] ++ optionals cfg.dap.enable [cfg.dap.package];

modules/plugins/languages/ts.nix

@@ -9,10 +9,11 @@
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.lists) isList;
   inherit (lib.meta) getExe;
-  inherit (lib.types) enum either listOf package str;
-  inherit (lib.nvim.lua) expToLua;
-  inherit (lib.nvim.types) mkGrammarOption diagnostics;
+  inherit (lib.types) enum either listOf package str bool;
+  inherit (lib.nvim.lua) expToLua toLuaObject;
+  inherit (lib.nvim.types) mkGrammarOption diagnostics mkPluginSetupOption;
   inherit (lib.nvim.languages) diagnosticsToLua;
+  inherit (lib.nvim.dag) entryAnywhere;
 
   cfg = config.vim.languages.ts;
 
@@ -32,6 +33,7 @@
         }
       '';
     };
+
     denols = {
       package = pkgs.deno;
       lspConfig = ''
@@ -143,6 +145,24 @@ in {
         inherit defaultDiagnosticsProvider;
       };
     };
+
+    extensions = {
+      ts-error-translator = {
+        enable = mkEnableOption ''
+          Typescript error translation with
+          [ts-error-translator.nvim](github.com/dmmulroy/ts-error-translator.nvim)
+        '';
+
+        setupOpts = mkPluginSetupOption "ts-error-translator" {
+          # This is the default configuration behaviour.
+          auto_override_publish_diagnostics = mkOption {
+            description = "Automatically override the publish_diagnostics handler";
+            type = bool;
+            default = true;
+          };
+        };
+      };
+    };
   };
 
   config = mkIf cfg.enable (mkMerge [
@@ -169,5 +189,12 @@ in {
         inherit diagnosticsProviders;
       };
     })
+
+    (mkIf cfg.extensions."ts-error-translator".enable {
+      vim.startPlugins = ["ts-error-translator"];
+      vim.luaConfigRC.ts-error-translator = entryAnywhere ''
+        require("ts-error-translator").setup(${toLuaObject cfg.extensions.ts-error-translator.setupOpts})
+      '';
+    })
   ]);
 }

modules/plugins/theme/theme.nix

@@ -45,10 +45,12 @@ in {
   config = mkIf cfg.enable {
     vim = {
       startPlugins = [cfg.name];
-      luaConfigRC = {
-        themeSetup = entryBefore ["theme"] cfg.extraConfig;
-        theme = supported_themes.${cfg.name}.setup (with cfg; {inherit style transparent;});
-      };
+      configRC.theme = entryBefore ["luaScript"] ''
+        lua << EOF
+        ${cfg.extraConfig}
+        ${supported_themes.${cfg.name}.setup (with cfg; {inherit style transparent;})}
+        EOF
+      '';
     };
   };
 }

modules/plugins/ui/borders/borders.nix

@@ -1,46 +0,0 @@
-{
-  config,
-  lib,
-  ...
-}: let
-  inherit (lib.options) mkOption mkEnableOption;
-  inherit (lib.lists) optionals;
-  inherit (lib.types) enum;
-
-  cfg = config.vim.ui.borders;
-
-  defaultStyles = ["none" "single" "double" "rounded"];
-in {
-  options.vim.ui.borders = {
-    enable = mkEnableOption "visible borders for most windows";
-
-    globalStyle = mkOption {
-      type = enum defaultStyles;
-      default = "rounded";
-      description = ''
-        The global border style to use.
-      '';
-    };
-
-    # TODO: make per-plugin borders configurable
-    plugins = let
-      mkPluginStyleOption = name: {
-        enable = mkEnableOption "borders for the ${name} plugin" // {default = cfg.enable;};
-
-        style = mkOption {
-          type = enum (defaultStyles ++ optionals (name != "which-key") ["shadow"]);
-          default = cfg.globalStyle;
-          description = "The border style to use for the ${name} plugin";
-        };
-      };
-    in {
-      # despite not having it listed in example configuration, which-key does support the rounded type
-      # additionally, it supports a "shadow" type that is similar to none but is of higher contrast
-      which-key = mkPluginStyleOption "which-key";
-      lspsaga = mkPluginStyleOption "lspsaga";
-      nvim-cmp = mkPluginStyleOption "nvim-cmp";
-      lsp-signature = mkPluginStyleOption "lsp-signature";
-      code-action-menu = mkPluginStyleOption "code-actions-menu";
-    };
-  };
-}

modules/plugins/ui/borders/default.nix

@@ -1,5 +0,0 @@
-{
-  imports = [
-    ./borders.nix
-  ];
-}

modules/plugins/ui/default.nix

@@ -1,12 +1,11 @@
 {
   imports = [
-    ./noice
-    ./modes
-    ./notifications
-    ./smartcolumn
+    ./breadcrumbs
     ./colorizer
     ./illuminate
-    ./breadcrumbs
-    ./borders
+    ./modes
+    ./noice
+    ./notifications
+    ./smartcolumn
   ];
 }