Merge branch 'main' into feat/open-official-website

2026-07-25 14:01:06 +00:00 · 2024-07-13 23:23:22 +08:00 · 2024-07-13 23:23:22 +08:00 · 45031f1c8a
commit 45031f1c8a
parent 2e1df526ca 1f8469a53c
15 changed files with 193 additions and 162 deletions
--- a/.github/.release-please-manifest.json
+++ b/.github/.release-please-manifest.json
@ -1,3 +1,3 @@
 {
-  ".": "12.27.0"
+  ".": "12.28.0"
 }
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@ -6,7 +6,10 @@ body:
  - type: markdown
    attributes:
      value: |
-        **Before** reporting an issue, make sure to read the [documentation](https://github.com/LazyVim/LazyVim) and search [existing issues](https://github.com/LazyVim/LazyVim/issues). Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/LazyVim/LazyVim/discussions) and will be closed.
+        **Before** reporting an issue, make sure to read the [documentation](https://github.com/LazyVim/LazyVim)
+        and search [existing issues](https://github.com/LazyVim/LazyVim/issues).
+
+        Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/LazyVim/LazyVim/discussions) and will be closed.
  - type: checkboxes
    attributes:
      label: Did you check docs and existing issues?
@ -57,33 +60,15 @@ body:
      label: Repro
      description: Minimal `init.lua` to reproduce this issue. Save as `repro.lua` and run with `nvim -u repro.lua`
      value: |
-        -- DO NOT change the paths and don't remove the colorscheme
-        local root = vim.fn.fnamemodify("./.repro", ":p")
+        vim.env.LAZY_STDPATH = ".repro"
+        load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))()

-        -- set stdpaths to use .repro
-        for _, name in ipairs({ "config", "data", "state", "cache" }) do
-          vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
-        end
-
-        -- bootstrap lazy
-        local lazypath = root .. "/plugins/lazy.nvim"
-        if not vim.loop.fs_stat(lazypath) then
-          vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", lazypath, })
-        end
-        vim.opt.runtimepath:prepend(lazypath)
-
-        -- install plugins
-        local plugins = {
-          "folke/tokyonight.nvim",
+        require("lazy.minit").repro({
+          spec = {
            { "LazyVim/LazyVim", import = "lazyvim.plugins" },
            -- add any other plugins here
-        }
-        require("lazy").setup(plugins, {
-          root = root .. "/plugins",
+          },
        })
-
-        vim.cmd.colorscheme("tokyonight")
-        -- add anything else here
-      render: Lua
+      render: lua
    validations:
      required: false
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,5 +1,21 @@
 # Changelog

+## [12.28.0](https://github.com/LazyVim/LazyVim/compare/v12.27.0...v12.28.0) (2024-07-12)
+
+
+### Features
+
+* new mappings format for which-key v3. Forgot to push :) ([702471e](https://github.com/LazyVim/LazyVim/commit/702471e454ff552189ab03325dc19d0f7a601704))
+
+
+### Bug Fixes
+
+* **autocmds:** fixed pattern for autocommand to autoenable wrap and spell in text files ([#3975](https://github.com/LazyVim/LazyVim/issues/3975)) ([927031a](https://github.com/LazyVim/LazyVim/commit/927031a2de93f694b032a4df5e6d93fff635a496))
+* **java:** fix `config_overrides` for tests ([#3968](https://github.com/LazyVim/LazyVim/issues/3968)) ([b481b64](https://github.com/LazyVim/LazyVim/commit/b481b644ddf9f02470ec50264e63c6dd69d444f8))
+* **outline:** use new object for `symbols.filter` ([#4006](https://github.com/LazyVim/LazyVim/issues/4006)) ([db234ef](https://github.com/LazyVim/LazyVim/commit/db234ef9cbbb1b7b0efa8e3af5c446b965e7c07a))
+* **php:** `php_cs_fixer` is the correct name ([#3991](https://github.com/LazyVim/LazyVim/issues/3991)) ([8bfd9a5](https://github.com/LazyVim/LazyVim/commit/8bfd9a50a71d8b8147f7d742e8d0f05ee6cba888))
+* **vscode:** allow overriding default vscode keymaps. Fixes [#3950](https://github.com/LazyVim/LazyVim/issues/3950) ([6765052](https://github.com/LazyVim/LazyVim/commit/67650528e47a57fb687bce2d7bb61fb4f1af8f63))
+
 ## [12.27.0](https://github.com/LazyVim/LazyVim/compare/v12.26.2...v12.27.0) (2024-07-07)


--- a/doc/LazyVim.txt
+++ b/doc/LazyVim.txt
@ -1,4 +1,4 @@
-*LazyVim.txt*               For Neovim               Last change: 2024 July 10
+*LazyVim.txt*               For Neovim               Last change: 2024 July 13

 ==============================================================================
 Table of Contents                                  *LazyVim-table-of-contents*
--- a/lua/lazyvim/config/init.lua
+++ b/lua/lazyvim/config/init.lua
@ -3,7 +3,7 @@ _G.LazyVim = require("lazyvim.util")
 ---@class LazyVimConfig: LazyVimOptions
 local M = {}

-M.version = "12.27.0" -- x-release-please-version
+M.version = "12.28.0" -- x-release-please-version
 M.WEBSITE = "https://www.lazyvim.org"
 LazyVim.config = M

--- a/lua/lazyvim/plugins/editor.lua
+++ b/lua/lazyvim/plugins/editor.lua
@ -162,32 +162,47 @@ return {
  {
    "folke/which-key.nvim",
    event = "VeryLazy",
+    opts_extend = { "spec" },
    opts = {
-      plugins = { spelling = true },
-      defaults = {
+      defaults = {},
+      spec = {
+        {
          mode = { "n", "v" },
-        ["g"] = { name = "+goto" },
-        ["gs"] = { name = "+surround" },
-        ["z"] = { name = "+fold" },
-        ["]"] = { name = "+next" },
-        ["["] = { name = "+prev" },
-        ["<leader><tab>"] = { name = "+tabs" },
-        ["<leader>b"] = { name = "+buffer" },
-        ["<leader>c"] = { name = "+code" },
-        ["<leader>f"] = { name = "+file/find" },
-        ["<leader>g"] = { name = "+git" },
-        ["<leader>gh"] = { name = "+hunks", ["_"] = "which_key_ignore" },
-        ["<leader>q"] = { name = "+quit/session" },
-        ["<leader>s"] = { name = "+search" },
-        ["<leader>u"] = { name = "+ui" },
-        ["<leader>w"] = { name = "+windows" },
-        ["<leader>x"] = { name = "+diagnostics/quickfix" },
+          { "<leader><tab>", group = "tabs" },
+          { "<leader>b", group = "buffer" },
+          { "<leader>c", group = "code" },
+          { "<leader>f", group = "file/find" },
+          { "<leader>g", group = "git" },
+          { "<leader>gh", group = "hunks" },
+          { "<leader>q", group = "quit/session" },
+          { "<leader>s", group = "search" },
+          { "<leader>u", group = "ui" },
+          { "<leader>w", group = "windows" },
+          { "<leader>x", group = "diagnostics/quickfix" },
+          { "[", group = "prev" },
+          { "]", group = "next" },
+          { "g", group = "goto" },
+          { "gs", group = "surround" },
+          { "z", group = "fold" },
+        },
+      },
+    },
+    keys = {
+      {
+        "<leader>?",
+        function()
+          require("which-key").show({ global = false })
+        end,
+        desc = "Buffer Local Keymaps (which-key)",
      },
    },
    config = function(_, opts)
      local wk = require("which-key")
      wk.setup(opts)
+      if not vim.tbl_isempty(opts.defaults) then
+        LazyVim.warn("which-key: opts.defaults is deprecated. Please use opts.spec instead.")
        wk.register(opts.defaults)
+      end
    end,
  },

--- a/lua/lazyvim/plugins/extras/editor/leap.lua
+++ b/lua/lazyvim/plugins/extras/editor/leap.lua
@ -7,10 +7,10 @@ return {
    "ggandor/flit.nvim",
    enabled = true,
    keys = function()
-      ---@type LazyKeys[]
+      ---@type LazyKeysSpec[]
      local ret = {}
      for _, key in ipairs({ "f", "F", "t", "T" }) do
-        ret[#ret + 1] = { key, mode = { "n", "x", "o" }, desc = key }
+        ret[#ret + 1] = { key, mode = { "n", "x", "o" } }
      end
      return ret
    end,
--- a/lua/lazyvim/plugins/extras/editor/outline.lua
+++ b/lua/lazyvim/plugins/extras/editor/outline.lua
@ -16,7 +16,7 @@ return {
      local opts = {
        symbols = {
          icons = {},
-          filter = LazyVim.config.kind_filter,
+          filter = vim.deepcopy(LazyVim.config.kind_filter),
        },
        keymaps = {
          up_and_jump = "<up>",
--- a/lua/lazyvim/plugins/extras/editor/overseer.lua
+++ b/lua/lazyvim/plugins/extras/editor/overseer.lua
@ -64,7 +64,9 @@ return {
    "folke/which-key.nvim",
    optional = true,
    opts = {
-      defaults = { ["<leader>o"] = { name = "+overseer" } },
+      spec = {
+        { "<leader>o", group = "overseer" },
+      },
    },
  },
  {
--- a/lua/lazyvim/plugins/extras/lang/java.lua
+++ b/lua/lazyvim/plugins/extras/lang/java.lua
@ -190,30 +190,40 @@ return {
          local client = vim.lsp.get_client_by_id(args.data.client_id)
          if client and client.name == "jdtls" then
            local wk = require("which-key")
-            wk.register({
-              ["<leader>cx"] = { name = "+extract" },
-              ["<leader>cxv"] = { require("jdtls").extract_variable_all, "Extract Variable" },
-              ["<leader>cxc"] = { require("jdtls").extract_constant, "Extract Constant" },
-              ["gs"] = { require("jdtls").super_implementation, "Goto Super" },
-              ["gS"] = { require("jdtls.tests").goto_subjects, "Goto Subjects" },
-              ["<leader>co"] = { require("jdtls").organize_imports, "Organize Imports" },
-            }, { mode = "n", buffer = args.buf })
-            wk.register({
-              ["<leader>c"] = { name = "+code" },
-              ["<leader>cx"] = { name = "+extract" },
-              ["<leader>cxm"] = {
+            wk.add({
+              {
+                mode = "n",
+                buffer = args.buf,
+                { "<leader>cx", group = "extract" },
+                { "<leader>cxv", require("jdtls").extract_variable_all, desc = "Extract Variable" },
+                { "<leader>cxc", require("jdtls").extract_constant, desc = "Extract Constant" },
+                { "gs", require("jdtls").super_implementation, desc = "Goto Super" },
+                { "gS", require("jdtls.tests").goto_subjects, desc = "Goto Subjects" },
+                { "<leader>co", require("jdtls").organize_imports, desc = "Organize Imports" },
+              },
+            })
+            wk.add({
+              {
+                mode = "v",
+                buffer = args.buf,
+                { "<leader>cx", group = "extract" },
+                {
+                  "<leader>cxm",
                  [[<ESC><CMD>lua require('jdtls').extract_method(true)<CR>]],
-                "Extract Method",
+                  desc = "Extract Method",
                },
-              ["<leader>cxv"] = {
+                {
+                  "<leader>cxv",
                  [[<ESC><CMD>lua require('jdtls').extract_variable_all(true)<CR>]],
-                "Extract Variable",
+                  desc = "Extract Variable",
                },
-              ["<leader>cxc"] = {
+                {
+                  "<leader>cxc",
                  [[<ESC><CMD>lua require('jdtls').extract_constant(true)<CR>]],
-                "Extract Constant",
+                  desc = "Extract Constant",
                },
-            }, { mode = "v", buffer = args.buf })
+              },
+            })

            if opts.dap and LazyVim.has("nvim-dap") and mason_registry.is_installed("java-debug-adapter") then
              -- custom init for Java debugger
@ -223,26 +233,32 @@ return {
              -- Java Test require Java debugger to work
              if opts.test and mason_registry.is_installed("java-test") then
                -- custom keymaps for Java test runner (not yet compatible with neotest)
-                wk.register({
-                  ["<leader>t"] = { name = "+test" },
-                  ["<leader>tt"] = {
+                wk.add({
+                  {
+                    mode = "n",
+                    buffer = args.buf,
+                    { "<leader>t", group = "test" },
+                    {
+                      "<leader>tt",
                      function()
                        require("jdtls.dap").test_class({
                          config_overrides = type(opts.test) ~= "boolean" and opts.test.config_overrides or nil,
                        })
                      end,
-                    "Run All Test",
+                      desc = "Run All Test",
                    },
-                  ["<leader>tr"] = {
+                    {
+                      "<leader>tr",
                      function()
                        require("jdtls.dap").test_nearest_method({
                          config_overrides = type(opts.test) ~= "boolean" and opts.test.config_overrides or nil,
                        })
                      end,
-                    "Run Nearest Test",
+                      desc = "Run Nearest Test",
                    },
-                  ["<leader>tT"] = { require("jdtls.dap").pick_test, "Run Test" },
-                }, { mode = "n", buffer = args.buf })
+                    { "<leader>tT", require("jdtls.dap").pick_test, desc = "Run Test" },
+                  },
+                })
              end
            end

--- a/lua/lazyvim/plugins/extras/lang/markdown.lua
+++ b/lua/lazyvim/plugins/extras/lang/markdown.lua
@ -100,6 +100,7 @@ return {
          headline_highlights = {},
          -- disable bullets for now. See https://github.com/lukas-reineke/headlines.nvim/issues/66
          bullets = {},
+          quote_string = false,
        }
        for i = 1, 6 do
          local hl = "Headline" .. i
--- a/lua/lazyvim/plugins/extras/lang/php.lua
+++ b/lua/lazyvim/plugins/extras/lang/php.lua
@ -74,13 +74,13 @@ return {
        php = { "phpcs" },
      },
    },
+  },
  {
    "stevearc/conform.nvim",
    optional = true,
    opts = {
      formatters_by_ft = {
-          php = { "php-cs-fixer" },
-        },
+        php = { "php_cs_fixer" },
      },
    },
  },
--- a/lua/lazyvim/plugins/extras/lang/r.lua
+++ b/lua/lazyvim/plugins/extras/lang/r.lua
@ -21,22 +21,19 @@ return {

          -- Increase the width of which-key to handle the longer r-nvim descriptions
          local wk = require("which-key")
-          -- Workaround from https://github.com/folke/which-key.nvim/issues/514#issuecomment-1987286901
-          wk.register({
-            ["<localleader>"] = {
-              a = { name = "+(a)ll", ["🚫"] = "which_key_ignore" },
-              b = { name = "+(b)etween marks", ["🚫"] = "which_key_ignore" },
-              c = { name = "+(c)hunks", ["🚫"] = "which_key_ignore" },
-              f = { name = "+(f)unctions", ["🚫"] = "which_key_ignore" },
-              g = { name = "+(g)oto", ["🚫"] = "which_key_ignore" },
-              k = { name = "+(k)nit", ["🚫"] = "which_key_ignore" },
-              p = { name = "+(p)aragraph", ["🚫"] = "which_key_ignore" },
-              q = { name = "+(q)uarto", ["🚫"] = "which_key_ignore" },
-              r = { name = "+(r) general", ["🚫"] = "which_key_ignore" },
-              s = { name = "+(s)plit or (s)end", ["🚫"] = "which_key_ignore" },
-              t = { name = "+(t)erminal", ["🚫"] = "which_key_ignore" },
-              v = { name = "+(v)iew", ["🚫"] = "which_key_ignore" },
-            },
+          wk.add({
+            { "<localleader>a", group = "all" },
+            { "<localleader>b", group = "between marks" },
+            { "<localleader>c", group = "chunks" },
+            { "<localleader>f", group = "functions" },
+            { "<localleader>g", group = "goto" },
+            { "<localleader>k", group = "knit" },
+            { "<localleader>p", group = "paragraph" },
+            { "<localleader>q", group = "quarto" },
+            { "<localleader>r", group = "r general" },
+            { "<localleader>s", group = "split or send" },
+            { "<localleader>t", group = "terminal" },
+            { "<localleader>v", group = "view" },
          })
        end,
      },
--- a/lua/lazyvim/util/mini.lua
+++ b/lua/lazyvim/util/mini.lua
@ -61,52 +61,51 @@ end

 -- register all text objects with which-key
 function M.ai_whichkey()
-  ---@type table<string, string|table>
-  local i = {
-    [" "] = "Whitespace",
-    ['"'] = 'Balanced "',
-    ["'"] = "Balanced '",
-    ["`"] = "Balanced `",
-    ["("] = "Balanced (",
-    [")"] = "Balanced ) including white-space",
-    [">"] = "Balanced > including white-space",
-    ["<lt>"] = "Balanced <",
-    ["]"] = "Balanced ] including white-space",
-    ["["] = "Balanced [",
-    ["}"] = "Balanced } including white-space",
-    ["{"] = "Balanced {",
-    ["?"] = "User Prompt",
-    _ = "Underscore",
-    a = "Argument",
-    b = "Balanced ), ], }",
-    c = "Class",
-    d = "Digit(s)",
-    e = "Word in CamelCase & snake_case",
-    f = "Function",
-    g = "Entire file",
-    i = "Indent",
-    o = "Block, conditional, loop",
-    q = "Quote `, \", '",
-    t = "Tag",
-    u = "Use/call function & method",
-    U = "Use/call without dot in name",
+  local objects = {
+    { " ", desc = "whitespace" },
+    { '"', desc = 'balanced "' },
+    { "'", desc = "balanced '" },
+    { "(", desc = "balanced (" },
+    { ")", desc = "balanced ) including white-space" },
+    { "<", desc = "balanced <" },
+    { ">", desc = "balanced > including white-space" },
+    { "?", desc = "user prompt" },
+    { "U", desc = "use/call without dot in name" },
+    { "[", desc = "balanced [" },
+    { "]", desc = "balanced ] including white-space" },
+    { "_", desc = "underscore" },
+    { "`", desc = "balanced `" },
+    { "a", desc = "argument" },
+    { "b", desc = "balanced )]}" },
+    { "c", desc = "class" },
+    { "d", desc = "digit(s)" },
+    { "e", desc = "word in CamelCase & snake_case" },
+    { "f", desc = "function" },
+    { "g", desc = "entire file" },
+    { "i", desc = "indent" },
+    { "o", desc = "block, conditional, loop" },
+    { "q", desc = "quote `\"'" },
+    { "t", desc = "tag" },
+    { "u", desc = "use/call function & method" },
+    { "{", desc = "balanced {" },
+    { "}", desc = "balanced } including white-space" },
  }
-  local a = vim.deepcopy(i)
-  for k, v in pairs(a) do
-    a[k] = v:gsub(" including.*", "")
-  end

-  local ic = vim.deepcopy(i)
-  local ac = vim.deepcopy(a)
-  for key, name in pairs({ n = "Next", l = "Last" }) do
-    i[key] = vim.tbl_extend("force", { name = "Inside " .. name .. " textobject" }, ic)
-    a[key] = vim.tbl_extend("force", { name = "Around " .. name .. " textobject" }, ac)
+  local ret = { mode = { "o", "x" } }
+  for prefix, name in pairs({
+    i = "inside",
+    a = "around",
+    il = "last",
+    ["in"] = "next",
+    al = "last",
+    an = "next",
+  }) do
+    ret[#ret + 1] = { prefix, group = name }
+    for _, obj in ipairs(objects) do
+      ret[#ret + 1] = { prefix .. obj[1], desc = obj.desc }
    end
-  require("which-key").register({
-    mode = { "o", "x" },
-    i = i,
-    a = a,
-  })
+  end
+  require("which-key").add(ret, { notify = false })
 end

 ---@param opts {skip_next: string, skip_ts: string[], skip_unbalanced: boolean, markdown: boolean}
--- a/scripts/test
+++ b/scripts/test
@ -1,3 +1,3 @@
 #!/bin/env bash

-nvim -l tests/minit.lua --busted tests -o utfTerminal "$@"
+nvim -l tests/minit.lua --minitest