Merge remote-tracking branch 'upstream/main' into vue_language_server

docs/manual.nix

@@ -31,13 +31,10 @@ in
 
     # Generate the final manual from a set of parameters. This uses
     # feel-co/ndg to render the web manual.
-    ndg html \
+    ndg --config-file ${./ndg.toml} html \
       --jobs $NIX_BUILD_CORES --title "NVF" \
       --module-options ${optionsJSON}/share/doc/nixos/options.json \
       --manpage-urls ${path}/doc/manpage-urls.json \
-      --options-depth 3 \
-      --generate-search \
-      --highlight-code \
       --input-dir ./manual \
       --output-dir "$out/share/doc"
 

docs/manual/configuring.md

@@ -17,6 +17,7 @@ configuring/custom-package.md
 configuring/custom-plugins.md
 configuring/overriding-plugins.md
 configuring/languages.md
+configuring/keybinds.md
 configuring/dags.md
 configuring/dag-entries.md
 configuring/autocmds.md

docs/manual/configuring/custom-plugins/configuring.md

@@ -19,7 +19,7 @@ hooks should do what you need.
 ```nix
 {
   config.vim.lazy.plugins = {
-    aerial.nvim = {
+    "aerial.nvim" = {
     # ^^^^^^^^^ this name should match the package.pname or package.name
       package = aerial-nvim;
 

docs/manual/configuring/keybinds.md

@@ -0,0 +1,38 @@
+# Custom keymaps {#ch-keymaps}
+
+Some plugin modules provide keymap options for your convenience. If a keymap is
+not provided by such module options, you may easily register your own custom
+keymaps via {option}`vim.keymaps`.
+
+```nix
+{
+  config.vim.keymaps = [
+    {
+      key = "<leader>m";
+      mode = "n";
+      silent = true;
+      action = ":make<CR>";
+    }
+    {
+      key = "<leader>l";
+      mode = ["n" "x"];
+      silent = true;
+      action = "<cmd>cnext<CR>";
+    }
+    {
+      key = "<leader>k";
+      mode = ["n" "x"];
+      
+      # While `lua` is `true`, `action` is expected to be
+      # a valid Lua expression.
+      lua = true;
+      action = ''
+        function()
+          require('foo').do_thing()
+          print('did thing')
+        end
+      '';
+    }
+  ];
+}
+```

docs/manual/configuring/languages/lsp.md

@@ -21,3 +21,43 @@ vim.languages.java = {
   };
 }
 ```
+
+## Custom LSP Servers {#ch-custom-lsp-servers}
+
+Neovim 0.11, in an effort to improve the out-of-the-box experience of Neovim,
+has introduced a new `vim.lsp` API that can be used to register custom LSP
+servers with ease. In **nvf**, this translates to the custom `vim.lsp` API that
+can be used to register servers that are not present in existing language
+modules.
+
+The {option}`vim.lsp.servers` submodule can be used to modify existing LSP
+definitions OR register your own custom LSPs respectively. For example, if you'd
+like to avoid having NVF pull the LSP packages you may modify the start command
+to use a string, which will cause the LSP API to discover LSP servers from
+{env}`PATH`. For example:
+
+```nix
+{lib, ...}: { 
+  vim.lsp.servers = {
+    # Get `basedpyright-langserver` from PATH, e.g., a dev shell.
+    basedpyright.cmd = lib.mkForce ["basedpyright-langserver" "--stdio"];
+
+    # Define a custom LSP entry using `vim.lsp.servers`:
+    ty = {
+      cmd = lib.mkDefault [(lib.getExe pkgs.ty) "server"];
+      filetypes = ["python"];
+      root_markers = [
+        ".git"
+        "pyproject.toml"
+        "setup.cfg"
+        "requirements.txt"
+        "Pipfile"
+        "pyrightconfig.json"
+      ];
+
+    # If your LSP accepts custom settings. See `:help lsp-config` for more details
+    # on available fields. This is a freeform field.
+    settings.ty = { /* ... */ };
+  };
+}
+```

docs/manual/configuring/overriding-plugins.md

@@ -14,11 +14,12 @@ vim.pluginOverrides = {
     rev = "";
     hash = "";
   };
+ 
  # It's also possible to use a flake input
  lazydev-nvim = inputs.lazydev-nvim;
  # Or a local path 
  lazydev-nvim = ./lazydev;
- # Or a npins pin... etc
+ # Or a npins pin nvfetcher source, etc.
 };
 ```
 

docs/manual/release-notes/rl-0.9.md

@@ -25,6 +25,31 @@
   - The `setupOpts.mappings` options were also removed. Use the built-in Neovim
     settings (nvf's {option}`vim.keymaps`)
 
+[Snoweuph](https://github.com/snoweuph)
+
+- "Correct `languages.go.treesitter` to contain all Go file types.
+  `languages.go.treesitter.package` is now `languages.go.treesitter.goPackage`.
+  New are:
+
+  - `languages.go.treesitter.goPackage`.
+
+  - `languages.go.treesitter.gomodPackage`.
+
+  - `languages.go.treesitter.gosumPackage`.
+
+  - `languages.go.treesitter.goworkPackage`.
+
+  - `languages.go.treesitter.gotmplPackage`.
+
+- Fix `vim.assistant.codecompanion-nvim.setupOpts.display.diff.provider` to only
+  allow valid options. `default` is no longer valid. `inline` and `split` are
+  two new valid options.
+
+- Added [taplo](https://taplo.tamasfe.dev/) as the default formatter and lsp for
+  `languages.toml` so we don't default to AI-Slop.
+
+- Added `json5` into `languages.json`. Some options where renamed.
+
 ## Changelog {#sec-release-0-9-changelog}
 
 [taylrfnt](https://github.com/taylrfnt)
@@ -54,6 +79,10 @@
   treesitter grammars were changed to prefer `grammarPlugins` over
   `builtGrammars`.
 
+[NotAShelf](https://github.com/notashelf):
+
+- Lazyload noice.nvim and nvim-web-devicons on `DeferredUIEnter`
+
 [jfeo](https://github.com/jfeo):
 
 [ccc.nvim]: https://github.com/uga-rosa/ccc.nvim
@@ -136,15 +165,137 @@
 
 - Added [sqruff](https://github.com/quarylabs/sqruff) support to `languages.sql`
 
-- Added [Pyrefly](https://pyrefly.org/) support to `languages.python`
+- Lazy-load `crates.nvim` plugin when using
+  `vim.languages.rust.extensions.crates-nvim.enable`
+
+- Added [Pyrefly](https://pyrefly.org/) and [zuban](https://zubanls.com/)
+  support to `languages.python`
 
 - Added TOML support via {option}`languages.toml` and the
   [Tombi](https://tombi-toml.github.io/tombi/) language server, linter, and
   formatter.
 
+- Added Jinja support via `languages.jinja`
+
 - Added [hlargs.nvim](https://github.com/m-demare/hlargs.nvim) support as
   `visuals.hlargs-nvim`.
 
+- Lazy-load `nvim-autopairs` plugin when using
+  `vim.autopairs.nvim-autopairs.enable`
+
 [Machshev](https://github.com/machshev):
 
 - Added `ruff` and `ty` LSP support for Python under `programs.python`.
+
+[Snoweuph](https://github.com/snoweuph)
+
+- Added [Selenen](https://github.com/kampfkarren/selene) for more diagnostics in
+  `languages.lua`.
+
+- Added [`mdformat`](https://mdformat.rtfd.io/) support to `languages.markdown`
+  with the extensions for [GFM](https://github.github.com/gfm/),
+  [front matter](https://www.markdownlang.com/advanced/frontmatter.html) and
+  [footnotes](https://www.markdownguide.org/extended-syntax/#footnotes).
+
+- Added XML syntax highlighting, LSP support and formatting
+
+- Added [mypy](https://www.mypy-lang.org/) to `languages.python` for extra
+  diagnostics.
+
+- Added [tera](https://keats.github.io/tera/) language support (syntax
+  highlighting only).
+
+- Added Debugging support to `languages.odin` with
+  [nvim-dap-odin](https://github.com/NANDquark/nvim-dap-odin).
+
+- Disabled notifications for
+  [nvim-dap-odin](https://github.com/NANDquark/nvim-dap-odin), because it
+  contain no use full information, only spam, and it can't be made lazy.
+
+- Added [`golangci-lint`](https://golangci-lint.run/) for more diagnostics.
+
+- Added [`gopher.nvim`](https://github.com/olexsmir/gopher.nvim) for extra
+  actions in `languages.go`.
+
+- updated default filetypes for
+  [harper-ls](https://github.com/Automattic/harper) to match what they are
+  supposed to be.
+
+- Added Makefile support via `languages.make`.
+
+- Fix `languages.hcl` init, depending on `comment-nvim` by checking if it is
+  enabled. Fixes a crash (#1350).
+
+- Add `languages.fluent` using the official plugin. This only provides
+  highlighting.
+
+- Added Debugging support to `languages.php`.
+
+- Added Formatting support to `languages.php` via
+  [PHP-CS-Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer).
+
+- Added minimal `languages.twig`. Currently using [djlint](https://djlint.com/)
+  for most options, as better alternatives like
+  [twig-cs-fixer](https://github.com/VincentLanglet/Twig-CS-Fixer) aren't
+  packaged for nix.
+
+- Didn't Add
+  [`syntax-gaslighting`](https://github.com/NotAShelf/syntax-gaslighting.nvim),
+  you're crazy.
+
+[vagahbond](https://github.com/vagahbond): [codewindow.nvim]:
+https://github.com/gorbit99/codewindow.nvim
+
+- Add [codewindow.nvim] plugin in `vim.assistant.codewindow` with `enable` and
+  `setupOpts`
+
+[irobot](https://github.com/irobot):
+
+- Fix non-functional `vim.keymaps.*.noremap`. Now, setting it to false is
+  equivalent to `:lua vim.keymap.set(..., { remap = true })`
+
+[kazimazi](https://github.com/kazimazi):
+
+- Added [`grug-far.nvim`](https://github.com/MagicDuck/grug-far.nvim) the find
+  and replace tool for neovim.
+- Fix lsp `client.supports_method` deprecation warning in nvim v0.12.
+- Add [`blink.indent`](https://github.com/saghen/blink.indent) indent guideline
+  plugin.
+
+[Ladas552](https://github.com/Ladas552)
+
+- Changed `withRuby` to not be enabled by default
+- Fix virtualtext mode in colorizer
+
+[horriblename](https://github.com/horriblename):
+
+- Ignore terminals by default in spell-checking
+
+[poz](https://poz.pet):
+
+[neocmakelsp]: https://github.com/neocmakelsp/neocmakelsp
+[arduino-language-server]: https://github.com/arduino/arduino-language-server
+[glsl_analyzer]: https://github.com/nolanderc/glsl_analyzer
+
+- Add CMake support with [neocmakelsp].
+- Add Arduino support with [arduino-language-server].
+- Add GLSL support with [glsl_analyzer].
+
+[itscrystalline](https://github.com/itscrystalline):
+
+[img-clip.nvim]: https://github.com/hakonharnes/img-clip.nvim
+
+- [img-clip.nvim]'s configuration now has it's own DAG entry, separate from
+  image-nvim.
+
+[phanirithvij](https://github.com/phanirithvij):
+
+[elm-language-server]: https://github.com/elm-tooling/elm-language-server
+
+- Add Elm support with [elm-language-server]
+
+[alv-around](https://github.com/alv-around):
+
+- Fix `vim.assistant.codecompanion-nvim` lazy loading with [blink-cmp]
+
+<!-- vim: set textwidth=80: -->

docs/ndg.toml

@@ -0,0 +1,28 @@
+# NDG Configuration File
+
+# Input directory containing markdown files
+input_dir = "docs"
+
+# Output directory for generated documentation
+output_dir = "build"
+
+# Title for the documentation
+title = "NVF"
+
+# Footer text for the documentation
+footer_text = "Generated with ndg"
+
+generate_anchors = true
+
+# Search configuration
+[search]
+enable = true
+highlight_code = true
+tab_style = "none"
+revision = "main"
+
+# Maximum heading level to index
+max_heading_level = 3
+
+# Depth of parent categories in options TOC
+options_toc_depth = 2