mirror of https://github.com/folke/lazy.nvim.git
docs: added plugin spec code
This commit is contained in:
parent
80a7839eec
commit
dc1d71d5cf
85
README.md
85
README.md
|
@ -69,10 +69,93 @@ require("lazy").setup({
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 🔌 Plugin Spec
|
||||||
|
|
||||||
|
<!-- spec_start -->
|
||||||
|
|
||||||
|
```lua
|
||||||
|
return {
|
||||||
|
-- the colorscheme should be available when starting Neovim
|
||||||
|
"folke/tokyonight.nvim",
|
||||||
|
|
||||||
|
-- I have a separate config.mappings file where I require which-key.
|
||||||
|
-- With lazy the plugin will be automatically loaded when it is required somewhere
|
||||||
|
{ "folke/which-key.nvim", lazy = true },
|
||||||
|
|
||||||
|
{
|
||||||
|
"nvim-neorg/neorg",
|
||||||
|
-- lazy-load on filetype
|
||||||
|
ft = "norg",
|
||||||
|
-- custom config that will be executed when loading the plugin
|
||||||
|
config = function()
|
||||||
|
require("neorg").setup()
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"dstein64/vim-startuptime",
|
||||||
|
-- lazy-load on a command
|
||||||
|
cmd = "StartupTime",
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"hrsh7th/nvim-cmp",
|
||||||
|
-- load cmp on InsertEnter
|
||||||
|
event = "InsertEnter",
|
||||||
|
-- these dependencies will only be loaded when cmp loads
|
||||||
|
-- dependencies are always lazy-loaded unless specified otherwise
|
||||||
|
dependencies = {
|
||||||
|
"hrsh7th/cmp-nvim-lsp",
|
||||||
|
"hrsh7th/cmp-buffer",
|
||||||
|
},
|
||||||
|
config = function()
|
||||||
|
-- ...
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
-- you can use the VeryLazy event for things that can
|
||||||
|
-- load later and are not important for the initial UI
|
||||||
|
{ "stevearc/dressing.nvim", event = "VeryLazy" },
|
||||||
|
|
||||||
|
{
|
||||||
|
"cshuaimin/ssr.nvim",
|
||||||
|
-- init is always executed during startup, but doesn't load the plugin yet.
|
||||||
|
-- init implies lazy loading
|
||||||
|
init = function()
|
||||||
|
vim.keymap.set({ "n", "x" }, "<leader>cR", function()
|
||||||
|
-- this require will automatically load the plugin
|
||||||
|
require("ssr").open()
|
||||||
|
end, { desc = "Structural Replace" })
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"monaqa/dial.nvim",
|
||||||
|
-- lazy-load on keys
|
||||||
|
keys = { "<C-a>", "<C-x>" },
|
||||||
|
},
|
||||||
|
|
||||||
|
-- local plugins need to be explicitely configured with dir
|
||||||
|
{ dir = "~/projects/secret.nvim" },
|
||||||
|
|
||||||
|
-- you can use a custom url to fetch a plugin
|
||||||
|
{ url = "git@github.com:folke/noice.nvim.git" },
|
||||||
|
|
||||||
|
-- local plugins can also be configure with the dev option.
|
||||||
|
-- This will use ~/projects/noice.nvim/ instead of fetching it from Github
|
||||||
|
-- With the dev option, you can easily switch between the local and installed version of a plugin
|
||||||
|
{ "folke/noice.nvim", dev = true },
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- spec_end -->
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## ⚙️ Configuration
|
||||||
|
|
||||||
**lazy.nvim** comes with the following defaults:
|
**lazy.nvim** comes with the following defaults:
|
||||||
|
|
||||||
|
<!-- config_start -->
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
{
|
{
|
||||||
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
|
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
|
||||||
|
@ -157,6 +240,8 @@ require("lazy").setup({
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<!-- config_end -->
|
||||||
|
|
||||||
## 🚀 Usage
|
## 🚀 Usage
|
||||||
|
|
||||||
## 📊 Profiler
|
## 📊 Profiler
|
||||||
|
|
|
@ -0,0 +1,72 @@
|
||||||
|
return {
|
||||||
|
-- the colorscheme should be available when starting Neovim
|
||||||
|
"folke/tokyonight.nvim",
|
||||||
|
|
||||||
|
-- I have a separate config.mappings file where I require which-key.
|
||||||
|
-- With lazy the plugin will be automatically loaded when it is required somewhere
|
||||||
|
{ "folke/which-key.nvim", lazy = true },
|
||||||
|
|
||||||
|
{
|
||||||
|
"nvim-neorg/neorg",
|
||||||
|
-- lazy-load on filetype
|
||||||
|
ft = "norg",
|
||||||
|
-- custom config that will be executed when loading the plugin
|
||||||
|
config = function()
|
||||||
|
require("neorg").setup()
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"dstein64/vim-startuptime",
|
||||||
|
-- lazy-load on a command
|
||||||
|
cmd = "StartupTime",
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"hrsh7th/nvim-cmp",
|
||||||
|
-- load cmp on InsertEnter
|
||||||
|
event = "InsertEnter",
|
||||||
|
-- these dependencies will only be loaded when cmp loads
|
||||||
|
-- dependencies are always lazy-loaded unless specified otherwise
|
||||||
|
dependencies = {
|
||||||
|
"hrsh7th/cmp-nvim-lsp",
|
||||||
|
"hrsh7th/cmp-buffer",
|
||||||
|
},
|
||||||
|
config = function()
|
||||||
|
-- ...
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
-- you can use the VeryLazy event for things that can
|
||||||
|
-- load later and are not important for the initial UI
|
||||||
|
{ "stevearc/dressing.nvim", event = "VeryLazy" },
|
||||||
|
|
||||||
|
{
|
||||||
|
"cshuaimin/ssr.nvim",
|
||||||
|
-- init is always executed during startup, but doesn't load the plugin yet.
|
||||||
|
-- init implies lazy loading
|
||||||
|
init = function()
|
||||||
|
vim.keymap.set({ "n", "x" }, "<leader>cR", function()
|
||||||
|
-- this require will automatically load the plugin
|
||||||
|
require("ssr").open()
|
||||||
|
end, { desc = "Structural Replace" })
|
||||||
|
end,
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
"monaqa/dial.nvim",
|
||||||
|
-- lazy-load on keys
|
||||||
|
keys = { "<C-a>", "<C-x>" },
|
||||||
|
},
|
||||||
|
|
||||||
|
-- local plugins need to be explicitely configured with dir
|
||||||
|
{ dir = "~/projects/secret.nvim" },
|
||||||
|
|
||||||
|
-- you can use a custom url to fetch a plugin
|
||||||
|
{ url = "git@github.com:folke/noice.nvim.git" },
|
||||||
|
|
||||||
|
-- local plugins can also be configure with the dev option.
|
||||||
|
-- This will use ~/projects/noice.nvim/ instead of fetching it from Github
|
||||||
|
-- With the dev option, you can easily switch between the local and installed version of a plugin
|
||||||
|
{ "folke/noice.nvim", dev = true },
|
||||||
|
}
|
Loading…
Reference in New Issue