irongit

A Neovim plugin enabling you to solve LeetCode problems.

docs: update readme

kawreauthored
parent 1d5bc26commit f593259dfddd5e1f8ab522a8c715bfbbe9bd8819Browse files

4 files changed, +22 -17

+10-0README.md
@@ -135,6 +135,16 @@ To see full configuration types see [template.lua](./lua/leetcode/config/templat
135135
136136 ---@type boolean
137137 image_support = false, -- setting this to `true` will disable question description wrap
138+
139+ keys = {
140+ toggle = { "q", "<Esc>" }, ---@type string|string[]
141+ confirm = { "<CR>" }, ---@type string|string[]
142+
143+ reset_testcases = "r", ---@type string
144+ use_testcase = "U", ---@type string
145+ focus_testcases = "H", ---@type string
146+ focus_result = "L", ---@type string
147+ },
138148 }
139149 ```
140150
+10-0README.zh.md
@@ -142,6 +142,16 @@ https://github.com/kawre/leetcode.nvim/assets/69250723/aee6584c-e099-4409-b114-1
142142
143143 ---@type boolean
144144 image_support = false, -- setting this to `true` will disable question description wrap
145+
146+ keys = {
147+ toggle = { "q", "<Esc>" }, ---@type string|string[]
148+ confirm = { "<CR>" }, ---@type string|string[]
149+
150+ reset_testcases = "r", ---@type string
151+ use_testcase = "U", ---@type string
152+ focus_testcases = "H", ---@type string
153+ focus_result = "L", ---@type string
154+ },
145155 }
146156 ```
147157
+0-13lua/leetcode.lua
@@ -18,19 +18,6 @@ end
1818 function leetcode.setup_cmds()
1919 local cmd = require("leetcode.command")
2020 cmd.setup()
21-
22- -- deprecate
23- local utils = require("leetcode.utils")
24- utils.deprecate_usr_cmd("LcConsole", "Leet console")
25- utils.deprecate_usr_cmd("LcHints", "Leet hints")
26- utils.deprecate_usr_cmd("LcMenu", "Leet")
27- utils.deprecate_usr_cmd("LcTabs", "Leet tabs")
28- utils.deprecate_usr_cmd("LcQuestionTabs", "Leet tabs")
29- utils.deprecate_usr_cmd("LcLanguage", "Leet lang")
30- utils.deprecate_usr_cmd("LcDescriptionToggle", "Leet desc toggle")
31- utils.deprecate_usr_cmd("LcRun", "Leet run")
32- utils.deprecate_usr_cmd("LcSubmit", "Leet submit")
33- utils.deprecate_usr_cmd("LcFix", "Leet fix")
3421 end
3522
3623 function leetcode.validate()
+2-4lua/leetcode/command/init.lua
@@ -191,7 +191,7 @@ function cmd.info()
191191 end
192192
193193 function cmd.hints()
194- cmd.deprecate("Leet hints", "Leet info")
194+ -- cmd.deprecate("Leet hints", "Leet info")
195195 cmd.info()
196196 end
197197
@@ -338,6 +338,7 @@ cmd.commands = {
338338 menu = { cmd.menu },
339339 console = { cmd.console },
340340 info = { cmd.info },
341+ hints = { cmd.hints },
341342 tabs = { cmd.question_tabs },
342343 lang = { cmd.change_lang },
343344 run = { cmd.q_run },
@@ -374,9 +375,6 @@ cmd.commands = {
374375 cache = {
375376 update = { cmd.cache_update },
376377 },
377-
378- ---@deprecated
379- hints = { cmd.hints },
380378 }
381379
382380 return cmd