docs: added lazyvim reference configs #499
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsouzadasilva
requested review from
NTBBloodbath and
boltlessengineer
as code owners
README.md
Outdated
Comment on lines
260
to
360
| #### LazyVim | ||
|
|
||
| plugins/rest-nvim.lua | ||
|
|
||
| ```lua | ||
| return { | ||
| { | ||
| "rest-nvim/tree-sitter-http", | ||
| }, | ||
| { | ||
| "nvim-treesitter/nvim-treesitter", | ||
| opts = { | ||
| ensure_installed = { | ||
| "http", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| "folke/which-key.nvim", | ||
| event = "VeryLazy", | ||
| opts_extend = { "spec" }, | ||
| opts = { | ||
| spec = { | ||
| { | ||
| mode = { "n", "v" }, | ||
| { "<leader>h", group = "rest", icon = { icon = "", color = "purple" } }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| "rest-nvim/rest.nvim", | ||
| event = "VeryLazy", | ||
| ft = { "http" }, | ||
| keys = { | ||
| { | ||
| "<leader>ho", | ||
| "<cmd>Rest open<cr>", | ||
| desc = "Open result pane", | ||
| }, | ||
| { | ||
| "<leader>hr", | ||
| "<cmd>Rest run<cr>", | ||
| desc = "Run request under the cursor", | ||
| }, | ||
| { | ||
| "<leader>hn", | ||
| function() | ||
| vim.ui.input({ prompt = "Enter request @name" }, function(input) | ||
| if input and input ~= "" then | ||
| vim.cmd("Rest run " .. input) | ||
| else | ||
| vim.notify("No input provided", vim.log.levels.ERROR) -- Show error | ||
| end | ||
| end) | ||
| end, | ||
| desc = "Run request with name <name>", | ||
| }, | ||
| { | ||
| "<leader>hh", | ||
| "<cmd>Rest last<cr>", | ||
| desc = "Run request under the cursor", | ||
| }, | ||
| { | ||
| "<leader>hl", | ||
| "<cmd>Rest logs<cr>", | ||
| desc = "Edit logs file", | ||
| }, | ||
| { | ||
| "<leader>hc", | ||
| "<cmd>Rest cookies<cr>", | ||
| desc = "Edit cookies file", | ||
| }, | ||
| { | ||
| "<leader>he", | ||
| "<cmd>Rest env show<cr>", | ||
| desc = "Show dotenv file registered to current .http file", | ||
| }, | ||
| { | ||
| "<leader>h.", | ||
| "<cmd>Rest env select<cr>", | ||
| desc = "Select & register .env file with vim.ui.select()", | ||
| }, | ||
| { | ||
| "<leader>hs", | ||
| function() | ||
| vim.ui.input({ prompt = "Enter env path" }, function(input) | ||
| if input and input ~= "" then | ||
| vim.cmd("Rest env set " .. input) | ||
| else | ||
| vim.notify("No input provided", vim.log.levels.ERROR) -- Show error | ||
| end | ||
| end) | ||
| end, | ||
| desc = "Register .env file to current .http file", | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| ``` |
There was a problem hiding this comment.
nitpick: enclosing the reference configs section children headers in an HTML <details> tag could reduce the visual clutter by default, If anyone wants to see them, they can use the toggle "button" text from the tag.
jsouzadasilva
force-pushed
the
feat/add-lazyvim-config-ref
branch
from
fd07262 to
d46ab92
Compare
|
Thanks for the PR and for taking the time to contribute! While I appreciate the effort, I think adding reference configs to the README isn’t the best fit for rest.nvim.
I’d like to keep the README focused on core usage and let users adapt the plugin to their setups. Maybe we can add this in wiki instead. |
Got it, I'm closing this then. If you need help adding this to the wiki let me know, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a section called "Reference configs", under "Usage". I added the reference for LazyVim, but this could be expanded for other neovim distributions.
The reference config can give people something to start with, or even use it as is.
Let me know if I should do any formatting of it's a bad idea to add this in the README.md.