chore(main): release 10.0.1 (#1680)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -1,5 +1,78 @@
 # Changelog
 
+## [10.0.1](https://github.com/LazyVim/LazyVim/compare/v10.0.0...v10.0.1) (2023-10-12)
+
+
+### Bug Fixes
+
+* **config:** make lazyvim.json idempotent, pretty-printed and remove full paths ([2a0b7a8](https://github.com/LazyVim/LazyVim/commit/2a0b7a88ba4b4562361dd5abb4a071547d004e59))
+* **toggle:** dont show incorrect deprecation warning for toggle. Fixes [#1679](https://github.com/LazyVim/LazyVim/issues/1679) ([7c7b4be](https://github.com/LazyVim/LazyVim/commit/7c7b4be8dbec5c5e888d02ebdaae944fecf99407))
+
+## [10.0.0](https://github.com/LazyVim/LazyVim/compare/v9.9.1...v10.0.0) (2023-10-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* **starter:** `dashboard.nvim` is now the default starter. To keep using `alpha.nvim`, enable the extra.
+* make `conform.nvim` and `nvim-lint` the default formatters/linters
+
+### Features
+
+* added aerial extra with integrations for edgy, telescope and lualine ([b43c57d](https://github.com/LazyVim/LazyVim/commit/b43c57d943b2a13460d45f01a288e98cb54f2c1f))
+* added NEWS.md and option to automatically show when changed (enabled by default) ([73acab1](https://github.com/LazyVim/LazyVim/commit/73acab16758d37982bd6b2d9b2be37c4ee83cde3))
+* **config:** better kind filter default for lua to deal with luals weirdness ([f64039f](https://github.com/LazyVim/LazyVim/commit/f64039f54620fe3fc9e8f464e35b184c6834ed6e))
+* **config:** load/save some data in lazyvim.json ([11d66e7](https://github.com/LazyVim/LazyVim/commit/11d66e713467410add9ad5a7a68a3bca0aa24082))
+* **config:** make kind filter configurable for telescope/aerial/... ([eb7a7d7](https://github.com/LazyVim/LazyVim/commit/eb7a7d7a8e586d30ed6839f4a621e0f019d32410))
+* **config:** use lazy's new custom events (`Event.mappings`) for a better `LazyFile` ([4ea1c68](https://github.com/LazyVim/LazyVim/commit/4ea1c6865e6d877207de8626e11a5a863950ae55))
+* **dashboard:** added LazyExtras shortcut to dashboard/alpha ([5bb7420](https://github.com/LazyVim/LazyVim/commit/5bb74205a06a89f048902ba142473dd679b228b8))
+* **extras:** added extra for `symbols-outline.nvim` ([b4ba5d8](https://github.com/LazyVim/LazyVim/commit/b4ba5d881dcb801d3c502665f9767d2f75ca1110))
+* **format:** new LazyVim formatter with integrations for lsp/none-ls/conform/eslint/... ([f1a8f24](https://github.com/LazyVim/LazyVim/commit/f1a8f24a361d0de198f6b1458168652a6835c932))
+* **inject:** util method to get upvalue ([14f3f03](https://github.com/LazyVim/LazyVim/commit/14f3f036e9223315f310ba9d35182690638e7bd7))
+* make `conform.nvim` and `nvim-lint` the default formatters/linters ([14c091b](https://github.com/LazyVim/LazyVim/commit/14c091b1fc6b0dc0b22ac49ccac69f8a02e3844c))
+* **mini.starter:** adding mini.starter to lualine disabled files ([#1667](https://github.com/LazyVim/LazyVim/issues/1667)) ([1c34af7](https://github.com/LazyVim/LazyVim/commit/1c34af7f0138323d9f465437d0bcef621a8dbe94))
+* **navic:** moved navic to extras ([305e82f](https://github.com/LazyVim/LazyVim/commit/305e82f2cacd5d0074027ea545a87a41379afc88))
+* **root:** allow custom functions as part of `vim.g.root_spec` ([c33e748](https://github.com/LazyVim/LazyVim/commit/c33e7489ecdaef7295a63079410f2f24a1cbc9b6))
+* **root:** cached pretty path function for statuslines ([8d7361c](https://github.com/LazyVim/LazyVim/commit/8d7361c4602993a7ea119cb7ce78d421b6787dfb))
+* **root:** customizable root detection and `:LazyRoot` command ([a2d6049](https://github.com/LazyVim/LazyVim/commit/a2d604928b5629d14797437a26022065f7385216))
+* **starter:** `dashboard.nvim` is now the default starter. To keep using `alpha.nvim`, enable the extra. ([4cbe42c](https://github.com/LazyVim/LazyVim/commit/4cbe42cd247c72dfc70c3fcddfa3fb6b5e6485e0))
+* **starter:** added Lazy Extras to `mini.starter` ([ce74e28](https://github.com/LazyVim/LazyVim/commit/ce74e28464daa7d694f9ab4e41fae3174e30c8b3))
+* **treesitter:** add nvim-treesitter-context by default ([7b2c317](https://github.com/LazyVim/LazyVim/commit/7b2c31740782fb0754ce715be6ea128083e48c4f))
+* **treesitter:** install nvim-ts-autotag by default ([cb7f5ac](https://github.com/LazyVim/LazyVim/commit/cb7f5aca7a04cf2d1d06397e9a80fe078d17976b))
+* **ui:** added `:LazyExtras` to manage enabled extras in LazyVim ([c4e55e4](https://github.com/LazyVim/LazyVim/commit/c4e55e4d67a7195b7aa9160cd8ece3ddc2f6cb51))
+* **ui:** show optional plugins in a different color ([eedb4a3](https://github.com/LazyVim/LazyVim/commit/eedb4a34050443448d0b752e22803d5b1278b419))
+* **util:** inject module ([e239235](https://github.com/LazyVim/LazyVim/commit/e239235cd34ac9c286eac1e620670784566ef673))
+
+
+### Bug Fixes
+
+* **aerial:** keymap ([c772027](https://github.com/LazyVim/LazyVim/commit/c7720275c3fa8b19c9ad7e05bfb6ed5c510bf2bb))
+* **dap:** copy config before overriding args ([72f3cc6](https://github.com/LazyVim/LazyVim/commit/72f3cc684bd1e8f19b2d3c56da3f359032b8c5dc))
+* **extras:** make sure we use priorities to import extras in correct order ([a4e3931](https://github.com/LazyVim/LazyVim/commit/a4e393154f61b95da5835b6461e211eb94740268))
+* **format:** always show formatter status even when no sources available ([a4abbdc](https://github.com/LazyVim/LazyVim/commit/a4abbdc89bd1d49378ac5873db1279e7e5398927))
+* **lualine:** when opening nvim with a file, show an empty statusline till lualine loads ([8373467](https://github.com/LazyVim/LazyVim/commit/83734675b0f93fbd11a350ee0662c09995836b59))
+* **neo-tree:** during init check global argslist instead of window-local ([8fbde2c](https://github.com/LazyVim/LazyVim/commit/8fbde2c3668960ed085f9225bb4650aca77cc495))
+* **nlua:** make nlua dap work with regular continue. Fixes [#1666](https://github.com/LazyVim/LazyVim/issues/1666) ([85215f3](https://github.com/LazyVim/LazyVim/commit/85215f396b6fd4de24636a202ec1149dafa5f7b5))
+* **notify:** set default zindex=100 ([7fb7948](https://github.com/LazyVim/LazyVim/commit/7fb79486ed1b251b98b95a44ef50b3742edd708d))
+* **plugin:** add nvim-treesitter-context rename warning ([db5d28b](https://github.com/LazyVim/LazyVim/commit/db5d28b039f656ccb47d3b9f787e8bb482cc6ec1))
+* **plugin:** enable lazy_file ([f59cdff](https://github.com/LazyVim/LazyVim/commit/f59cdff4d9f04ff349cefdee0b363d573954ce0d))
+* **plugin:** show warning of removed core plugin when trying to load them without having the extra ([3256abd](https://github.com/LazyVim/LazyVim/commit/3256abda65ae03358ecdbef1c7789782440fe39e))
+* **root:** only use workspace folders that contain the buffer ([592f3b0](https://github.com/LazyVim/LazyVim/commit/592f3b03bb3cd01df42ee5db4cd6ba43937f067e))
+* **ui:** dont show left signs on virtual line numbers (wrap). Fixes [#1654](https://github.com/LazyVim/LazyVim/issues/1654) ([e6d294d](https://github.com/LazyVim/LazyVim/commit/e6d294df6fbd973644d4b7f9691d5f48cc5efdde))
+
+
+### Performance Improvements
+
+* **lualine:** get rid of lualine's weird lualine_require ([13dbe4a](https://github.com/LazyVim/LazyVim/commit/13dbe4ad55a4e4b9a3dd345521b359411cdc5879))
+* **plugin:** move all lazy.nvim related code to `lazyvim.util.plugin` ([70f9195](https://github.com/LazyVim/LazyVim/commit/70f91956e7f03e740b51cbc14c87df6a6f74538f))
+* **util:** split lazyvim.util in smaller separate modules ([c8c929c](https://github.com/LazyVim/LazyVim/commit/c8c929c9fdc44cc69cb034c47bd89d2bc4e4a429))
+
+## [9.9.1](https://github.com/LazyVim/LazyVim/compare/v9.9.0...v9.9.1) (2023-10-11)
+
+
+### Bug Fixes
+
+* **config:** disable LazyFile till v10.0 ([ee7a401](https://github.com/LazyVim/LazyVim/commit/ee7a401388f2933729afcd7090fb8e69631b912f))
+
 ## [9.9.0](https://github.com/LazyVim/LazyVim/compare/v9.8.0...v9.9.0) (2023-10-10)
 
 

NEWS.md

@@ -0,0 +1,65 @@
+# What's new?
+
+## 10.x
+
+- `nvim-ts-autotag` is now included by default
+
+- `nvim-treesitter-context` is now included by default
+
+- Added extra for `symbols-outline.nvim`
+
+- Added extra for `aerial.nvim`
+
+- `nvim-navic` has been removed. If you want to keep using `nvim-navic`,
+  you can enable the **editor.navic** extra
+
+- New `:LazyExtras` command for managing **LazyVim** extras
+
+- Improved **formatting**:
+
+  - **LazyVim** can now work with multiple formatters. Types:
+
+    - **primary**: only one primary formatter can be active at a time.
+      _(conform, none-ls, LSP)_
+    - **secondary**: multiple secondary formatters can be active _(eslint, ...)_
+
+  - **LazyVim** automatically selects the primary formatter based on the
+    current available sources and priorities.
+
+  - New `:LazyFormat` command for formatting the current selection or buffer
+  - New `:LazyFormatInfo` command for displaying the active formatters
+    for the current buffer
+  - Auto-formatting can be disabled with:
+
+    ```lua
+    vim.g.autoformat = false -- globally
+    vim.b.autoformat = false -- buffer-local
+    ```
+
+- `none-ls.nvim` is no longer installed by default
+
+  - `conform.nvim` is now the default formatter
+  - `nvim-lint` is now the default linter
+  - If you want to keep using `none-ls.nvim`,
+    you can enable the **lsp.none-ls** extra
+
+- `dashboard.nvim` is the new default dashboard plugin
+
+  - If you want to keep using `alpha.nvim`, you can enable the **ui.alpha** extra
+
+- Improved **root detection**:
+
+  - New `:LazyRoot` command that shows info about the root dir detection
+  - Configurable with `vim.g.root_spec`
+
+    ```lua
+    -- LazyVim root dir detection
+    -- Each entry can be:
+    -- * the name of a detector function like `lsp` or `cwd`
+    -- * a pattern or array of patterns like `.git` or `lua`.
+    -- * a function with signature `function(buf) -> string|string[]`
+    vim.g.root_spec = { "lsp", { ".git", "lua" }, "cwd" }
+
+    -- To disable root detection set to just "cwd"
+    vim.g.root_spec = { "cwd" }
+    ```

doc/LazyVim.txt

@@ -1,4 +1,4 @@
-*LazyVim.txt*         For Neovim >= 0.8.0         Last change: 2023 October 11
+*LazyVim.txt*         For Neovim >= 0.8.0         Last change: 2023 October 12
 
 ==============================================================================
 Table of Contents                                  *LazyVim-table-of-contents*

lua/lazyvim/config/init.lua

@@ -3,7 +3,7 @@ local Util = require("lazyvim.util")
 ---@class LazyVimConfig: LazyVimOptions
 local M = {}
 
-M.version = "10.0.0" -- x-release-please-version
+M.version = "10.0.1" -- x-release-please-version
 
 ---@class LazyVimOptions
 local defaults = {
@@ -19,6 +19,13 @@ local defaults = {
     -- lazyvim.config.options can't be configured here since that's loaded before lazyvim setup
     -- if you want to disable loading options, add `package.loaded["lazyvim.config.options"] = true` to the top of your init.lua
   },
+  news = {
+    -- When enabled, NEWS.md will be shown when changed.
+    -- This only contains big new features and breaking changes.
+    lazyvim = true,
+    -- Same but for Neovim's news.txt
+    neovim = false,
+  },
   -- icons used by other plugins
   -- stylua: ignore
   icons = {
@@ -123,6 +130,7 @@ local defaults = {
 M.json = {
   data = {
     version = nil, ---@type string?
+    news = {}, ---@type table<string, string>
     extras = {}, ---@type string[]
   },
 }
@@ -136,6 +144,11 @@ function M.json.load()
     local ok, json = pcall(vim.json.decode, data, { luanil = { object = true, array = true } })
     if ok then
       M.json.data = vim.tbl_deep_extend("force", M.json.data, json or {})
+      if M.json.data.hashes then
+        ---@diagnostic disable-next-line: no-unknown
+        M.json.data.hashes = nil
+        M.json.save()
+      end
     end
   end
 end
@@ -144,7 +157,7 @@ function M.json.save()
   local path = vim.fn.stdpath("config") .. "/lazyvim.json"
   local f = io.open(path, "w")
   if f then
-    f:write(vim.json.encode(M.json.data))
+    f:write(Util.json.encode(M.json.data))
     f:close()
   end
 end
@@ -172,9 +185,8 @@ function M.setup(opts)
       end
       M.load("keymaps")
 
-      Util.warn("This branch has been merged on main. Please update your config.")
-
       Util.format.setup()
+      Util.news.setup()
 
       vim.api.nvim_create_user_command("LazyRoot", function()
         Util.root.info()

lua/lazyvim/config/keymaps.lua

@@ -125,7 +125,7 @@ map("n", "<leader>qq", "<cmd>qa<cr>", { desc = "Quit all" })
 map("n", "<leader>ui", vim.show_pos, { desc = "Inspect Pos" })
 
 -- LazyVim Changelog
-map("n", "<leader>L", Util.changelog, {desc = "LazyVim Changelog"})
+map("n", "<leader>L", function() Util.news.changelog() end, { desc = "LazyVim Changelog" })
 
 -- floating terminal
 local lazyterm = function() Util.terminal(nil, { cwd = Util.root() }) end

lua/lazyvim/util/format.lua

@@ -130,7 +130,7 @@ function M.health()
   local has_extra = vim.tbl_contains(Config.spec.modules, "lazyvim.plugins.extras.lsp.none-ls")
   if has_plugin and not has_extra then
     Util.warn({
-      "`conform.nvim` and `nvim-lint` are now the default forrmatters and linters in LazyVim.",
+      "`conform.nvim` and `nvim-lint` are now the default formatters and linters in LazyVim.",
       "",
       "You can use those plugins together with `none-ls.nvim`,",
       "but you need to enable the `lazyvim.plugins.extras.lsp.none-ls` extra,",

lua/lazyvim/util/init.lua

@@ -11,6 +11,8 @@ local LazyUtil = require("lazy.core.util")
 ---@field plugin lazyvim.util.plugin
 ---@field extras lazyvim.util.extras
 ---@field inject lazyvim.util.inject
+---@field news lazyvim.util.news
+---@field json lazyvim.util.json
 local M = {}
 
 ---@type table<string, string|string[]>
@@ -21,7 +23,6 @@ local deprecated = {
   root_patterns = { "root", "patterns" },
   get_root = { "root", "get" },
   float_term = { "terminal", "open" },
-  toggle = { "toggle", "option" },
   toggle_diagnostics = { "toggle", "diagnostics" },
   toggle_number = { "toggle", "number" },
   fg = "ui",
@@ -137,14 +138,6 @@ function M.on_load(name, fn)
   end
 end
 
-function M.changelog()
-  local lv = require("lazy.core.config").plugins.LazyVim
-  local float = require("lazy.util").open(lv.dir .. "/CHANGELOG.md")
-  vim.wo[float.win].spell = false
-  vim.wo[float.win].wrap = false
-  vim.diagnostic.disable(float.buf)
-end
-
 -- Wrapper around vim.keymap.set that will
 -- not create a keymap if a lazy key handler exists.
 -- It will also set `silent` to true by default.

lua/lazyvim/util/json.lua

@@ -0,0 +1,48 @@
+local Util = require("lazyvim.util")
+
+---@class lazyvim.util.json
+local M = {}
+
+---@param value any
+---@param indent string
+local function encode(value, indent)
+  local t = type(value)
+
+  if t == "string" then
+    return string.format("%q", value)
+  elseif t == "number" or t == "boolean" then
+    return tostring(value)
+  elseif t == "table" then
+    local is_list = Util.is_list(value)
+    local parts = {}
+    local next_indent = indent .. "  "
+
+    if is_list then
+      ---@diagnostic disable-next-line: no-unknown
+      for _, v in ipairs(value) do
+        local e = encode(v, next_indent)
+        if e then
+          table.insert(parts, next_indent .. e)
+        end
+      end
+      return "[\n" .. table.concat(parts, ",\n") .. "\n" .. indent .. "]"
+    else
+      local keys = vim.tbl_keys(value)
+      table.sort(keys)
+      ---@diagnostic disable-next-line: no-unknown
+      for _, k in ipairs(keys) do
+        local e = encode(value[k], next_indent)
+        if e then
+          table.insert(parts, next_indent .. string.format("%q", k) .. ": " .. e)
+        end
+      end
+      return "{\n" .. table.concat(parts, ",\n") .. "\n" .. indent .. "}"
+    end
+  end
+end
+
+function M.encode(value)
+  return encode(value, "")
+end
+
+return M

lua/lazyvim/util/news.lua

@@ -0,0 +1,78 @@
+local Config = require("lazyvim.config")
+local Util = require("lazyvim.util")
+
+---@class lazyvim.util.news
+local M = {}
+
+function M.hash(file)
+  local stat = vim.loop.fs_stat(file)
+  if not stat then
+    return
+  end
+  return stat.size .. ""
+end
+
+function M.setup()
+  vim.schedule(function()
+    if Config.news.lazyvim then
+      M.lazyvim(true)
+    end
+    if Config.news.neovim then
+      M.neovim(true)
+    end
+  end)
+end
+
+function M.changelog()
+  M.open("CHANGELOG.md", { plugin = "LazyVim" })
+end
+
+function M.lazyvim(when_changed)
+  M.open("NEWS.md", { plugin = "LazyVim", when_changed = when_changed })
+end
+
+function M.neovim(when_changed)
+  M.open("doc/news.txt", { rtp = true, when_changed = when_changed })
+end
+
+---@param file string
+---@param opts? {plugin?:string, rtp?:boolean, when_changed?:boolean}
+function M.open(file, opts)
+  local ref = file
+  opts = opts or {}
+  if opts.plugin then
+    local plugin = require("lazy.core.config").plugins[opts.plugin] --[[@as LazyPlugin?]]
+    if not plugin then
+      return Util.error("plugin not found: " .. opts.plugin)
+    end
+    file = plugin.dir .. "/" .. file
+  elseif opts.rtp then
+    file = vim.api.nvim_get_runtime_file(file, false)[1]
+  end
+
+  if not file then
+    return Util.error("File not found")
+  end
+
+  if opts.when_changed then
+    local hash = M.hash(file)
+    if hash == Config.json.data.news[ref] then
+      return
+    end
+    Config.json.data.news[ref] = hash
+    Config.json.save()
+  end
+
+  local float = require("lazy.util").float({
+    file = file,
+    size = { width = 0.6, height = 0.6 },
+  })
+  vim.wo[float.win].spell = false
+  vim.wo[float.win].wrap = false
+  vim.wo[float.win].signcolumn = "yes"
+  vim.wo[float.win].statuscolumn = " "
+  vim.wo[float.win].conceallevel = 3
+  vim.diagnostic.disable(float.buf)
+end
+
+return M