feat: added NEWS.md and option to automatically show when changed (enabled by default)

lua/lazyvim/util/init.lua

@@ -11,6 +11,7 @@ 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
 local M = {}
 
 ---@type table<string, string|string[]>
@@ -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/news.lua

@@ -0,0 +1,77 @@
+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)
+  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.hashes[file] then
+      return
+    end
+    Config.json.data.hashes[file] = 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