Skip to content

Commit e80aa66

Browse files
authored
Add optional packer plugins hook (#20)
* Add optional packer plugins hook * Provide help in README and simplify module * Fix spelling and tweak verbiage about after/plugin
1 parent e311d48 commit e80aa66

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,37 @@ This repo is meant to be used as a starting point for a user's own configuration
1818
* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
1919
* Restart Neovim
2020

21+
### Configuration
22+
23+
You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
24+
25+
An alternative approach is to create a separate `custom.plugins` module to register your own plugins. In addition, you can handle further customizations in the `/after/plugin/` directory (see `:help load-plugins`). See the following examples for more information. Leveraging this technique should make upgrading to a newer version of this repo easier.
26+
27+
#### Example `plugins.lua`
28+
29+
The following is an example of a `plugins.lua` module (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register your own plugins.
30+
31+
```lua
32+
return function(use)
33+
use({
34+
"folke/which-key.nvim",
35+
config = function()
36+
require("which-key").setup({})
37+
end
38+
})
39+
end
40+
```
41+
42+
#### Example `defaults.lua`
43+
44+
For further customizations, you can add a file in the `/after/plugin/` folder (see `:help load-plugins`) to include your own options, keymaps, autogroups, and more. The following is an example `defaults.lua` file (located at `$HOME/.config/nvim/after/plugin/defaults.lua`).
45+
46+
```lua
47+
vim.opt.relativenumber = true
48+
49+
vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
50+
```
51+
2152
### Contribution
2253

2354
Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included:

init.lua

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ require('packer').startup(function(use)
5757
-- Fuzzy Finder Algorithm which requires local dependencies to be built. Only load if `make` is available
5858
use { 'nvim-telescope/telescope-fzf-native.nvim', run = 'make', cond = vim.fn.executable 'make' == 1 }
5959

60+
-- Add custom plugins to packer from /nvim/lua/custom/plugins.lua
61+
local has_plugins, plugins = pcall(require, "custom.plugins")
62+
if has_plugins then plugins(use) end
63+
6064
if is_bootstrap then
6165
require('packer').sync()
6266
end

0 commit comments

Comments
 (0)