nvim-neorocks / nvim-best-practices

Collection of DOs and DON'Ts for modern Neovim Lua plugin development
Creative Commons Zero v1.0 Universal
310 stars 7 forks source link

request: add recommendation for an issue reproduction template #11

Open mikavilpas opened 4 months ago

mikavilpas commented 4 months ago

In my project (https://github.com/mikavilpas/yazi.nvim), I have a lazy.nvim lua script that I have been handing out to some people who have had issues. We have had good success with it, the issues being (mostly) easily reproducible.

Here's what I have used as a reference:

Details

```lua -- DO NOT change the paths and don't remove the colorscheme local root = vim.fn.fnamemodify('./.repro', ':p') -- set stdpaths to use .repro for _, name in ipairs({ 'config', 'data', 'state', 'cache' }) do vim.env[('XDG_%s_HOME'):format(name:upper())] = root .. '/' .. name end -- bootstrap lazy local lazypath = root .. '/plugins/lazy.nvim' if not vim.loop.fs_stat(lazypath) then vim.fn.system({ 'git', 'clone', '--filter=blob:none', 'https://github.com/folke/lazy.nvim.git', lazypath, }) end vim.opt.runtimepath:prepend(lazypath) vim.g.mapleader = ' ' -- install plugins local plugins = { 'folke/tokyonight.nvim', { 'mikavilpas/yazi.nvim', dependencies = { 'nvim-lua/plenary.nvim', }, event = 'VeryLazy', keys = { { -- 👇 choose your own keymapping 'fy', function() require('yazi').yazi() end, { desc = 'Open the file manager' }, }, }, opts = { open_for_directories = false, }, }, } require('lazy').setup(plugins, { root = root .. '/plugins', }) vim.cmd.colorscheme('tokyonight') -- add anything else here ```

I copied it from the lazy.nvim project and slightly adapted it.

Disregarding the lazy.nvim specific parts, in principle I think this could be a good addition to the guide.

What do you think? How do you reproduce issues in your projects?

mrcjkb commented 4 months ago

Hey :wave:

thanks for the suggestion. That's actually something I forgot to add :sweat_smile: