From 48ffb9bfd5db6208a015b09e93472b47eabb2f08 Mon Sep 17 00:00:00 2001 From: Folke Lemaitre Date: Thu, 27 Oct 2022 14:49:11 +0200 Subject: [PATCH] fix: load defaults as function to prevent require loops on older neovim versions --- lua/noice/config/init.lua | 297 +++++++++++++++++++------------------- 1 file changed, 150 insertions(+), 147 deletions(-) diff --git a/lua/noice/config/init.lua b/lua/noice/config/init.lua index 629d2da..8e3e263 100644 --- a/lua/noice/config/init.lua +++ b/lua/noice/config/init.lua @@ -6,163 +6,166 @@ local M = {} M.ns = vim.api.nvim_create_namespace("messages_highlights") ----@class NoiceConfig -M.defaults = { - cmdline = { - enabled = true, -- enables the Noice cmdline UI - view = "cmdline_popup", -- view for rendering the cmdline. Change to `cmdline` to get a classic cmdline at the bottom - opts = {}, -- global options for the cmdline. See section on views - ---@type table - format = { - -- conceal: (default=true) This will hide the text in the cmdline that matches the pattern. - -- view: (default is cmdline view) - -- opts: any options passed to the view - -- icon_hl_group: optional hl_group for the icon - -- title: set to anything or empty string to hide - cmdline = { pattern = "^:", icon = "", lang = "vim" }, - search_down = { kind = "search", pattern = "^/", icon = " ", lang = "regex" }, - search_up = { kind = "search", pattern = "^%?", icon = " ", lang = "regex" }, - filter = { pattern = "^:%s*!", icon = "$", lang = "bash" }, - lua = { pattern = "^:%s*lua%s+", icon = "", lang = "lua" }, - help = { pattern = "^:%s*he?l?p?%s+", icon = "" }, - input = {}, -- Used by input() - -- lua = false, -- to disable a format, set to `false` +function M.defaults() + ---@class NoiceConfig + local defaults = { + cmdline = { + enabled = true, -- enables the Noice cmdline UI + view = "cmdline_popup", -- view for rendering the cmdline. Change to `cmdline` to get a classic cmdline at the bottom + opts = {}, -- global options for the cmdline. See section on views + ---@type table + format = { + -- conceal: (default=true) This will hide the text in the cmdline that matches the pattern. + -- view: (default is cmdline view) + -- opts: any options passed to the view + -- icon_hl_group: optional hl_group for the icon + -- title: set to anything or empty string to hide + cmdline = { pattern = "^:", icon = "", lang = "vim" }, + search_down = { kind = "search", pattern = "^/", icon = " ", lang = "regex" }, + search_up = { kind = "search", pattern = "^%?", icon = " ", lang = "regex" }, + filter = { pattern = "^:%s*!", icon = "$", lang = "bash" }, + lua = { pattern = "^:%s*lua%s+", icon = "", lang = "lua" }, + help = { pattern = "^:%s*he?l?p?%s+", icon = "" }, + input = {}, -- Used by input() + -- lua = false, -- to disable a format, set to `false` + }, }, - }, - messages = { - -- NOTE: If you enable messages, then the cmdline is enabled automatically. - -- This is a current Neovim limitation. - enabled = true, -- enables the Noice messages UI - view = "notify", -- default view for messages - view_error = "notify", -- view for errors - view_warn = "notify", -- view for warnings - view_history = "split", -- view for :messages - view_search = "virtualtext", -- view for search count messages. Set to `false` to disable - }, - popupmenu = { - enabled = true, -- enables the Noice popupmenu UI - ---@type 'nui'|'cmp' - backend = "nui", -- backend to use to show regular cmdline completions - ---@type NoicePopupmenuItemKind|false - -- Icons for completion item kinds (see defaults at noice.config.icons.kinds) - kind_icons = {}, -- set to `false` to disable icons - }, - -- You can add any custom commands below that will be available with `:Noice command` - ---@type table - commands = { - history = { - -- options for the message history that you get with `:Noice` - view = "split", - opts = { enter = true, format = "details" }, - filter = { event = { "msg_show", "notify" }, ["not"] = { kind = { "search_count", "echo" } } }, + messages = { + -- NOTE: If you enable messages, then the cmdline is enabled automatically. + -- This is a current Neovim limitation. + enabled = true, -- enables the Noice messages UI + view = "notify", -- default view for messages + view_error = "notify", -- view for errors + view_warn = "notify", -- view for warnings + view_history = "split", -- view for :messages + view_search = "virtualtext", -- view for search count messages. Set to `false` to disable }, - -- :Noice last - last = { - view = "popup", - opts = { enter = true, format = "details" }, - filter = { event = { "msg_show", "notify" }, ["not"] = { kind = { "search_count", "echo" } } }, - filter_opts = { count = 1 }, + popupmenu = { + enabled = true, -- enables the Noice popupmenu UI + ---@type 'nui'|'cmp' + backend = "nui", -- backend to use to show regular cmdline completions + ---@type NoicePopupmenuItemKind|false + -- Icons for completion item kinds (see defaults at noice.config.icons.kinds) + kind_icons = {}, -- set to `false` to disable icons }, - -- :Noice errors - errors = { - -- options for the message history that you get with `:Noice` - view = "popup", - opts = { enter = true, format = "details" }, - filter = { error = true }, - filter_opts = { reverse = true }, + -- You can add any custom commands below that will be available with `:Noice command` + ---@type table + commands = { + history = { + -- options for the message history that you get with `:Noice` + view = "split", + opts = { enter = true, format = "details" }, + filter = { event = { "msg_show", "notify" }, ["not"] = { kind = { "search_count", "echo" } } }, + }, + -- :Noice last + last = { + view = "popup", + opts = { enter = true, format = "details" }, + filter = { event = { "msg_show", "notify" }, ["not"] = { kind = { "search_count", "echo" } } }, + filter_opts = { count = 1 }, + }, + -- :Noice errors + errors = { + -- options for the message history that you get with `:Noice` + view = "popup", + opts = { enter = true, format = "details" }, + filter = { error = true }, + filter_opts = { reverse = true }, + }, }, - }, - notify = { - -- Noice can be used as `vim.notify` so you can route any notification like other messages - -- Notification messages have their level and other properties set. - -- event is always "notify" and kind can be any log level as a string - -- The default routes will forward notifications to nvim-notify - -- Benefit of using Noice for this is the routing and consistent history view - enabled = true, - view = "notify", - }, - lsp = { - progress = { + notify = { + -- Noice can be used as `vim.notify` so you can route any notification like other messages + -- Notification messages have their level and other properties set. + -- event is always "notify" and kind can be any log level as a string + -- The default routes will forward notifications to nvim-notify + -- Benefit of using Noice for this is the routing and consistent history view enabled = true, - -- Lsp Progress is formatted using the builtins for lsp_progress. See config.format.builtin - -- See the section on formatting for more details on how to customize. - --- @type NoiceFormat|string - format = "lsp_progress", - --- @type NoiceFormat|string - format_done = "lsp_progress_done", - throttle = 1000 / 30, -- frequency to update lsp progress message - view = "mini", - }, - hover = { - enabled = false, - view = nil, -- when nil, use defaults from documentation - ---@type NoiceViewOptions - opts = {}, -- merged with defaults from documentation + view = "notify", }, - signature = { - enabled = false, - auto_open = true, -- Automatically show signature help when typing a trigger character from the LSP - view = nil, -- when nil, use defaults from documentation - ---@type NoiceViewOptions - opts = {}, -- merged with defaults from documentation + lsp = { + progress = { + enabled = true, + -- Lsp Progress is formatted using the builtins for lsp_progress. See config.format.builtin + -- See the section on formatting for more details on how to customize. + --- @type NoiceFormat|string + format = "lsp_progress", + --- @type NoiceFormat|string + format_done = "lsp_progress_done", + throttle = 1000 / 30, -- frequency to update lsp progress message + view = "mini", + }, + hover = { + enabled = false, + view = nil, -- when nil, use defaults from documentation + ---@type NoiceViewOptions + opts = {}, -- merged with defaults from documentation + }, + signature = { + enabled = false, + auto_open = true, -- Automatically show signature help when typing a trigger character from the LSP + view = nil, -- when nil, use defaults from documentation + ---@type NoiceViewOptions + opts = {}, -- merged with defaults from documentation + }, + -- defaults for hover and signature help + documentation = { + view = "hover", + ---@type NoiceViewOptions + opts = { + lang = "markdown", + replace = true, + render = "plain", + format = { "{message}" }, + win_options = { concealcursor = "n", conceallevel = 3 }, + }, + }, }, - -- defaults for hover and signature help - documentation = { - view = "hover", - ---@type NoiceViewOptions - opts = { - lang = "markdown", - replace = true, - render = "plain", - format = { "{message}" }, - win_options = { concealcursor = "n", conceallevel = 3 }, + markdown = { + hover = { + ["|(%S-)|"] = vim.cmd.help, -- vim help links + ["%[.-%]%((%S-)%)"] = require("noice.util").open, -- markdown links }, + highlights = { + ["|%S-|"] = "@text.reference", + ["@%S+"] = "@parameter", + ["^%s*(Parameters:)"] = "@text.title", + ["^%s*(Return:)"] = "@text.title", + ["^%s*(See also:)"] = "@text.title", + ["{%S-}"] = "@parameter", + }, + }, + health = { + checker = true, -- Disable if you don't want health checks to run }, - }, - markdown = { - hover = { - ["|(%S-)|"] = vim.cmd.help, -- vim help links - ["%[.-%]%((%S-)%)"] = require("noice.util").open, -- markdown links + smart_move = { + -- noice tries to move out of the way of existing floating windows. + enabled = true, -- you can disable this behaviour here + -- add any filetypes here, that shouldn't trigger smart move. + excluded_filetypes = { "cmp_menu", "cmp_docs", "notify" }, }, - highlights = { - ["|%S-|"] = "@text.reference", - ["@%S+"] = "@parameter", - ["^%s*(Parameters:)"] = "@text.title", - ["^%s*(Return:)"] = "@text.title", - ["^%s*(See also:)"] = "@text.title", - ["{%S-}"] = "@parameter", + ---@type NoicePresets + presets = { + -- you can enable a preset by setting it to true, or a table that will override the preset config + -- you can also add custom presets that you can enable/disable with enabled=true + bottom_search = false, -- use a classic bottom cmdline for search + command_palette = false, -- position the cmdline and popupmenu together + long_message_to_split = false, -- long messages will be sent to a split + inc_rename = false, -- enables an input dialog for inc-rename.nvim }, - }, - health = { - checker = true, -- Disable if you don't want health checks to run - }, - smart_move = { - -- noice tries to move out of the way of existing floating windows. - enabled = true, -- you can disable this behaviour here - -- add any filetypes here, that shouldn't trigger smart move. - excluded_filetypes = { "cmp_menu", "cmp_docs", "notify" }, - }, - ---@type NoicePresets - presets = { - -- you can enable a preset by setting it to true, or a table that will override the preset config - -- you can also add custom presets that you can enable/disable with enabled=true - bottom_search = false, -- use a classic bottom cmdline for search - command_palette = false, -- position the cmdline and popupmenu together - long_message_to_split = false, -- long messages will be sent to a split - inc_rename = false, -- enables an input dialog for inc-rename.nvim - }, - throttle = 1000 / 30, -- how frequently does Noice need to check for ui updates? This has no effect when in blocking mode. - ---@type NoiceConfigViews - views = {}, ---@see section on views - ---@type NoiceRouteConfig[] - routes = {}, --- @see section on routes - ---@type table - status = {}, --- @see section on statusline components - ---@type NoiceFormatOptions - format = {}, --- @see section on formatting - debug = false, - log = vim.fn.stdpath("state") .. "/noice.log", -} + throttle = 1000 / 30, -- how frequently does Noice need to check for ui updates? This has no effect when in blocking mode. + ---@type NoiceConfigViews + views = {}, ---@see section on views + ---@type NoiceRouteConfig[] + routes = {}, --- @see section on routes + ---@type table + status = {}, --- @see section on statusline components + ---@type NoiceFormatOptions + format = {}, --- @see section on formatting + debug = false, + log = vim.fn.stdpath("state") .. "/noice.log", + } + return defaults +end --- @type NoiceConfig M.options = {} @@ -181,7 +184,7 @@ function M.setup(options) options.popupmenu.kind_icons = nil end - M.options = vim.tbl_deep_extend("force", {}, M.defaults, { + M.options = vim.tbl_deep_extend("force", {}, M.defaults(), { views = require("noice.config.views").defaults, status = require("noice.config.status").defaults, format = require("noice.config.format").defaults,