From 21351b3a264d659e5eadf9c5f14351975c84f6fc Mon Sep 17 00:00:00 2001 From: JuanZoran <1430359574@qq.com> Date: Wed, 15 Mar 2023 19:27:21 +0800 Subject: [PATCH] chore: use conf.theme instead of conf.style.theme --- README.md | 156 ++++++++++++++------------- lua/Trans/core/conf.lua | 18 ++-- lua/Trans/core/setup.lua | 2 +- lua/Trans/core/translate.lua | 3 +- lua/Trans/frontend/hover/execute.lua | 2 +- lua/Trans/frontend/hover/init.lua | 2 +- 6 files changed, 92 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 2bda1a7..fb7271c 100644 --- a/README.md +++ b/README.md @@ -233,87 +233,91 @@ use { ## 配置 ```lua -require'Trans'.setup { - view = { - i = 'float', - n = 'hover', - v = 'hover', - }, - hover = { - width = 37, - height = 27, - border = 'rounded', - title = vim.fn.has('nvim-0.9') == 1 and { - { '', 'TransTitleRound' }, - { ' Trans', 'TransTitle' }, - { '', 'TransTitleRound' }, - } or nil, - keymap = { - pageup = '[[', - pagedown = ']]', - pin = '[', - close = ']', - toggle_entry = ';', - play = '_', +require'Trans'.setup{ + ---@type string the directory for database file and password file + dir = os.getenv('HOME') .. '/.vim/dict', + ---@type table modeStrategy default strategy for mode + strategy = { + ---@type { frontend:string, backend:string } fallback strategy for mode + default = { + frontend = 'hover', + backend = '*', }, - animation = { - -- open = 'fold', - -- close = 'fold', - open = 'slid', - close = 'slid', - interval = 12, + }, + ---@type table fallback backend for mode + backend = { + ---@class TransBackendOpts + default = { + ---@type integer timeout for backend send request + timeout = 2000, }, - auto_close_events = { - 'InsertEnter', - 'CursorMoved', - 'BufLeave', + }, + ---@type table frontend options + frontend = { + ---@class TransFrontendOpts + ---@field keymaps table + default = { + ---@type boolean Whether to auto play the audio + auto_play = true, + border = 'rounded', + title = title, -- need nvim-0.9 + ---@type {open: string | boolean, close: string | boolean, interval: integer} Hover Window Animation + animation = { + open = 'slid', -- 'fold', 'slid' + close = 'slid', + interval = 12, + }, + }, + ---@class TransHoverOpts : TransFrontendOpts + hover = { + ---@type integer Max Width of Hover Window + width = 37, + ---@type integer Max Height of Hover Window + height = 27, + ---@type string -- see: /lua/Trans/style/spinner + spinner = 'dots', + ---@type string -- TODO :support replace with {{special word}} + fallback_message = '翻译超时或没有找到相关的翻译', + auto_resize = true, + padding = 10, -- padding for hover window width + keymaps = { + -- play = '_', -- Deprecated + pageup = '[[', + pagedown = ']]', + pin = '[', + close = ']', + toggle_entry = ';', + }, + ---@type string[] auto close events + auto_close_events = { + 'InsertEnter', + 'CursorMoved', + 'BufLeave', + }, + ---@type string[] order to display translate result + order = { + 'title', + 'tag', + 'pos', + 'exchange', + 'translation', + 'definition', + }, + ---@type table + icon = { + -- or use emoji + star = '', -- ⭐ + notfound = ' ', -- ❔ + yes = '✔', -- ✔️ + no = '', -- ❌ + cell = '■', -- ■ | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉ █ + }, }, - auto_play = true, - timeout = 2000, - spinner = 'dots', -- 查看所有样式: /lua/Trans/util/spinner - -- spinner = 'moon' }, - order = { -- only work on hover mode - 'title', - 'tag', - 'pos', - 'exchange', - 'translation', - 'definition', + style = { + ---@type string global Trans theme [see lua/Trans/style/theme.lua] + theme = 'default', -- default | tokyonight | dracula }, - icon = { - star = '', - notfound = ' ', - yes = '✔', - no = '', - -- --- char: ■ | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉ █ - -- --- ◖■■■■■■■◗▫◻ ▆ ▆ ▇⃞ ▉⃞ - cell = '■', - -- star = '⭐', - -- notfound = '❔', - -- yes = '✔️', - -- no = '❌' - }, - theme = 'default', - dir = vim.fn.expand('$HOME/.vim/dict'), - -- float = { - -- width = 0.8, - -- height = 0.8, - -- border = 'rounded', - -- keymap = { - -- quit = 'q', - -- }, - -- animation = { - -- open = 'fold', - -- close = 'fold', - -- interval = 10, - -- }, - -- tag = { - -- wait = '#519aba', - -- fail = '#e46876', - -- success = '#10b981', - -- }, - -- }, } ``` diff --git a/lua/Trans/core/conf.lua b/lua/Trans/core/conf.lua index c1e4e19..03c9ca9 100644 --- a/lua/Trans/core/conf.lua +++ b/lua/Trans/core/conf.lua @@ -7,7 +7,6 @@ if vim.fn.has('nvim-0.9') == 1 then } end - ---@class Trans ---@field conf TransConf @@ -16,9 +15,11 @@ end return { ---@type string the directory for database file and password file dir = os.getenv('HOME') .. '/.vim/dict', - ---@type table modeStrategy default strategy for mode + query = 'fallback', + ---@type 'default' | 'dracula' | 'tokyonight' global Trans theme [see lua/Trans/style/theme.lua] + theme = 'default', -- default | tokyonight | dracula strategy = { - ---@type { frontend:string, backend:string } fallback strategy for mode + ---@type { frontend:string, backend:string | string[] } fallback strategy for mode default = { frontend = 'hover', backend = '*', @@ -26,9 +27,8 @@ return { }, ---@type table fallback backend for mode backend = { - ---@class TransBackendOpts + ---@class TransBackendOpts -- TODO :More core options default = { - ---@type integer timeout for backend send request timeout = 2000, }, }, @@ -57,16 +57,16 @@ return { ---@type string -- see: /lua/Trans/style/spinner spinner = 'dots', ---@type string -- TODO :support replace with {{special word}} - fallback_message = '翻译超时或没有找到相关的翻译', + fallback_message = '{{notfound}} 翻译超时或没有找到相关的翻译', auto_resize = true, padding = 10, -- padding for hover window width keymaps = { - -- play = '_', -- Deprecated pageup = '[[', pagedown = ']]', pin = '[', close = ']', toggle_entry = ';', + -- play = '_', -- Deprecated }, ---@type string[] auto close events auto_close_events = { @@ -94,10 +94,6 @@ return { }, }, }, - style = { - ---@type string global Trans theme [see lua/Trans/style/theme.lua] - theme = 'default', -- default | tokyonight | dracula - }, } diff --git a/lua/Trans/core/setup.lua b/lua/Trans/core/setup.lua index 6b2a7a8..cd4ec2f 100644 --- a/lua/Trans/core/setup.lua +++ b/lua/Trans/core/setup.lua @@ -60,7 +60,7 @@ end local function define_highlights(conf) local set_hl = vim.api.nvim_set_hl - local highlights = Trans.style.theme[conf.style.theme] + local highlights = Trans.style.theme[conf.theme] for hl, opt in pairs(highlights) do set_hl(0, hl, opt) end diff --git a/lua/Trans/core/translate.lua b/lua/Trans/core/translate.lua index b9f9936..4c45377 100644 --- a/lua/Trans/core/translate.lua +++ b/lua/Trans/core/translate.lua @@ -22,6 +22,8 @@ local function do_query(data) ---@type TransFrontend local frontend = data.frontend local result = data.result + + for _, backend in ipairs(data.backends) do ---@cast backend TransBackend local name = backend.name @@ -40,7 +42,6 @@ local function do_query(data) result[name] = nil end end - end diff --git a/lua/Trans/frontend/hover/execute.lua b/lua/Trans/frontend/hover/execute.lua index 1c17ef3..3ad7407 100644 --- a/lua/Trans/frontend/hover/execute.lua +++ b/lua/Trans/frontend/hover/execute.lua @@ -12,6 +12,7 @@ local strategy = { pin = function(hover) if hover.pin then return end + hover.pin = true local window = hover.window local width, height = window:width(), window:height() local col = vim.o.columns - width - 3 @@ -25,7 +26,6 @@ local strategy = { }) window:set('wrap', true) - hover.pin = true end, close = function(hover) diff --git a/lua/Trans/frontend/hover/init.lua b/lua/Trans/frontend/hover/init.lua index 8939d99..6fc9a95 100644 --- a/lua/Trans/frontend/hover/init.lua +++ b/lua/Trans/frontend/hover/init.lua @@ -124,7 +124,6 @@ function M:wait(tbl, name, timeout) pause(interval) end - -- FIXME : -- buffer:wipe() -- vim.api.nvim_buf_set_lines(buffer.bufnr, 1, -1, true, {}) @@ -139,6 +138,7 @@ end ---@param result TransResult ---@overload fun(result:TransResult) function M:process(data, result) + if self.pin then return end -- local node = Trans.util.node -- local it, t, f = node.item, node.text, node.format -- self.buffer:setline(it('hello', 'MoreMsg'))