lazy.nvim/README.md

80 lines
2.7 KiB
Markdown
Raw Normal View History

2022-11-26 21:31:29 +08:00
# lazy.nvim
2022-11-28 14:36:46 +08:00
## ✨ Features
2022-11-29 07:15:13 +08:00
- [x] Partial clones instead of shallow clones
- [x] waits till missing deps are installed (bootstrap Neovim and start using it right away)
- [x] Async
- [x] No need for compile
- [x] Fast
- [x] Correct sequencing of dependencies (deps should always be opt. Maybe make everything opt?)
- [x] Config in multiple files
- [x] Patterns for local packages
- [x] Profiling
- [x] lockfile
2022-11-29 19:16:09 +08:00
- [x] upvalues in `config` & `init`
- [x] check for updates
2022-12-01 06:15:14 +08:00
- [x] lazy-lock.lua
2022-11-29 07:15:13 +08:00
- [x] tag/version support `git tag --sort version:refname`
- [x] auto-loading on completion for lazy-loaded commands
2022-11-29 19:49:15 +08:00
- [x] bootstrap code
2022-11-29 07:15:13 +08:00
- [x] semver https://devhints.io/semver
2022-11-28 14:36:46 +08:00
https://semver.npmjs.com/
2022-11-26 21:31:29 +08:00
## ✅ TODO
- [ ] health checks: check merge conflicts async
- [ ] unsupported props or props from other managers
- [x] rename `run` to `build`
- [ ] delete lazy keymaps when a plugin loads
- [x] allow setting up plugins through config
- [x] task timeout
2022-12-01 06:15:14 +08:00
- [ ] log file
- [ ] deal with re-sourcing init.lua. Check a global?
2022-12-01 06:15:14 +08:00
- [x] incorrect when switching TN from opt to start
- [ ] git tests
- [x] max concurrency
- [x] ui border
- [ ] make sure we can reload specs while keeping state
- [ ] show disabled plugins (strikethrough?)
- [ ] Import specs from Packer
- [ ] use uv file watcher (or stat) to check for config changes
- [ ] [packspec](https://github.com/nvim-lua/nvim-package-specification)
- [ ] add support to specify `engines`, `os` and `cpu` like in `package.json`
- [ ] semver merging. Should check if two or more semver ranges are compatible and calculate the union range
- default semver merging strategy: if no version matches all, then use highest version?
- [x] support for Plugin.lock
2022-11-29 22:25:09 +08:00
- [x] defaults for git log
2022-11-29 19:02:25 +08:00
- [x] view keybindings for update/clean/...
- [x] add profiler to view
- [x] add buttons for actions
2022-11-29 07:15:13 +08:00
- [x] show time taken for op in view
2022-11-28 14:36:46 +08:00
- [ ] package meta index (package.lua cache for all packages)
2022-11-26 21:31:29 +08:00
- [ ] auto lazy-loading of lua modules
- [x] clear errors
2022-11-29 07:15:13 +08:00
- [x] add support for versions `git tag --sort v:refname`
2022-11-29 22:25:09 +08:00
- [x] rename requires to dependencies
2022-11-29 07:15:13 +08:00
- [x] move tasks etc to Plugin.state
2022-11-30 02:58:23 +08:00
- [x] handlers imply opt
- [x] dependencies imply opt for deps
2022-11-29 22:25:09 +08:00
- [x] fix local plugin spec
- [ ] investigate all opt=true. Simplifies logic (easily switch between opt/start afterwards)
2022-11-29 22:25:09 +08:00
## 📦 Differences with Packer
- **Plugin Spec**:
- `setup` => `init`
- `requires` => `dependencies`
- `as` => `name`
2022-12-01 18:32:52 +08:00
- `opt` => `lazy`
- `run` => `build`
2022-12-01 06:15:14 +08:00
## 📦 Other Neovim Plugin Managers in Lua
- [packer.nvim](https://github.com/wbthomason/packer.nvim)
- [paq-nvim](https://github.com/savq/paq-nvim)
- [neopm](https://github.com/ii14/neopm)
- [dep](https://github.com/chiyadev/dep)
- [optpack.nvim](https://github.com/notomo/optpack.nvim)