nvim-lua/wishlist

Embeddable Lua module system

Open

#13 opened on Jan 31, 2021

View on GitHub
 (1 comment) (2 reactions) (0 assignees) (0 forks)github user discovery
help wantedidea

Repository metrics

Stars
 (249 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

What? I want to embed some of my own Lua module for plugins. For example, The Vim script has https://github.com/vim-jp/vital.vim that is easy to embed custom module to other plugins.

Why? I want to try and error when I create some of the modules. But currently, the neovim community's approach is hard to apply breaking changes. For example, I think plenary.nvim is being hard to apply breaking change.

Potential existing implementations: https://github.com/vim-jp/vital.vim is the ideal solution, I think.

Potential pitfalls: Probably, it will make the users are being to do Reinventing the wheel but Lua plugin ecosystem will be grown, I think.

Contributor guide

Research direction
Research the vital.vim module system and propose a similar design for Lua in Neovim, considering how to allow easy embedding and breaking changes.
Tech stack
lua
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Lua
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70