irongit

A Neovim plugin enabling you to solve LeetCode problems.

docs(readme): alerts

kawreauthored
parent cef8703commit bcc06bb90e835d2cb8dd10c456f2860b5f0bd77dBrowse files

4 files changed, +25 -17

+11-8README.md
@@ -1,9 +1,5 @@
11 <div align="center">
22
3-🚨 **leetcode.nvim is currently in the _alpha stage_ of development** 🚨
4-
5----
6-
73 # leetcode.nvim
84
95 🔥 Solve [LeetCode] problems within [Neovim] 🔥
@@ -14,6 +10,11 @@
1410
1511 https://github.com/kawre/leetcode.nvim/assets/69250723/aee6584c-e099-4409-b114-123cb32b7563
1612
13+> [!CAUTION]
14+> This plugin has been exclusively tested with `Java`.
15+> If you encounter any errors while using other languages,
16+> please open an issue to report them.
17+
1718 ## ✨ Features
1819
1920 - 📌 an intuitive dashboard for effortless navigation within [leetcode.nvim]
@@ -268,8 +269,9 @@ hooks = {
268269
269270 Whether to render question description images using [image.nvim]
270271
271-Enabling this will disable question description wrap,
272-because of https://github.com/3rd/image.nvim/issues/62#issuecomment-1778082534
272+> [!WARNING]
273+> Enabling this will disable question description wrap,
274+> because of https://github.com/3rd/image.nvim/issues/62#issuecomment-1778082534
273275
274276 ```lua
275277 ---@type boolean
@@ -365,8 +367,9 @@ https://github.com/kawre/leetcode.nvim/assets/69250723/b7be8b95-5e2c-4153-8845-4
365367
366368 ### 💤 lazy loading with [lazy.nvim]
367369
368-<small>🚨 _**opting for either option makes the alternative
369-launch method unavailable due to lazy loading.**_</small>
370+> [!WARNING]
371+> opting for either option makes the alternative
372+> launch method unavailable due to lazy loading
370373
371374 - with [`arg`](#arg)
372375
+9-7README.zh.md
@@ -1,9 +1,5 @@
11 <div align="center">
22
3-🚨 **leetcode.nvim 目前处于 _alpha 阶段_ 开发中** 🚨
4-
5----
6-
73 # leetcode.nvim
84
95 🔥 在 [Neovim] 中解决 [LeetCode] 问题 🔥
@@ -14,6 +10,10 @@
1410
1511 https://github.com/kawre/leetcode.nvim/assets/69250723/aee6584c-e099-4409-b114-123cb32b7563
1612
13+> [!CAUTION]
14+> 此插件仅与`Java`进行了专门测试。
15+> 如果您在使用其他语言时遇到任何错误,请打开一个问题报告它们。
16+
1717 ## ✨ 特性
1818
1919 - 📌 直观的仪表板,轻松导航 [leetcode.nvim] 内
@@ -271,8 +271,9 @@ hooks = {
271271
272272 是否使用 [image.nvim] 渲染问题描述中的图片
273273
274-启用此选项将禁用问题描述的换行,因为
275-https://github.com/3rd/image.nvim/issues/62#issuecomment-1778082534
274+> [!WARNING]
275+> 启用此选项将禁用问题描述的换行,因为
276+> https://github.com/3rd/image.nvim/issues/62#issuecomment-1778082534
276277
277278 ```lua
278279 ---@type boolean
@@ -367,7 +368,8 @@ https://github.com/kawre/leetcode.nvim/assets/69250723/b7be8b95-5e2c-4153-8845-4
367368
368369 ### 💤 使用 [lazy.nvim] 进行延迟加载
369370
370-<small>🚨 _**选择其中任一选项将由于延迟加载而使另一启动方法不可用。**_</small>
371+> [!WARNING]
372+> 选择其中任一选项将由于延迟加载而使另一启动方法不可用。
371373
372374 - 使用 [`arg`](#arg)
373375
+1-0lua/leetcode-ui/popup/console/result.lua
@@ -52,6 +52,7 @@ function ResultPopup:init(parent)
5252 win_options = {
5353 winhighlight = "Normal:NormalSB,FloatBorder:FloatBorder",
5454 wrap = true,
55+ linebreak = true,
5556 },
5657 })
5758
+4-2lua/leetcode-ui/popup/console/testcase.lua
@@ -73,9 +73,10 @@ function Testcase:draw_extmarks()
7373 if not md.params then return end
7474
7575 local j = 1
76+ local pad = (" "):rep(2)
7677 local function get_param(idx)
7778 return {
78- { (" "):rep(2) },
79+ { pad },
7980 { "", "Operator" },
8081 { " " },
8182 { md.params[idx].name, "Comment" },
@@ -94,7 +95,7 @@ function Testcase:draw_extmarks()
9495 if line ~= "" then
9596 local ok, text = pcall(get_param, j)
9697 if not ok or invalid then
97- text = { { (" "):rep(2) }, { (" %s"):format(t("invalid")), "leetcode_error" } }
98+ text = { { pad }, { (" %s"):format(t("invalid")), "leetcode_error" } }
9899 end
99100
100101 self:add_extmark(i - 1, -1, { virt_text = text })
@@ -163,6 +164,7 @@ function Testcase:init(parent)
163164 win_options = {
164165 winhighlight = "Normal:NormalSB,FloatBorder:FloatBorder",
165166 wrap = true,
167+ linebreak = true,
166168 },
167169 })
168170