mirror of https://github.com/folke/lazy.nvim.git
docs: updated docs
This commit is contained in:
parent
1daf321580
commit
c6b76bdc70
53
README.md
53
README.md
|
@ -23,59 +23,18 @@ Modern plugin manager for Neovim
|
||||||
- 📋 Commit, branch, tag, version, and full [Semver](https://devhints.io/semver) support
|
- 📋 Commit, branch, tag, version, and full [Semver](https://devhints.io/semver) support
|
||||||
- 📈 Statusline component to see the number of pending updates
|
- 📈 Statusline component to see the number of pending updates
|
||||||
|
|
||||||
## ✅ TODO
|
|
||||||
|
|
||||||
- [x] fancy UI to manage all your Neovim plugins
|
|
||||||
- [x] auto lazy-loading of lua modules
|
|
||||||
- [x] lazy-loading on events, commands, filetypes and key mappings
|
|
||||||
- [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 to manually compile
|
|
||||||
- [x] Fast. Automatically caches and compiles byte code of all lua modules needed during startup
|
|
||||||
- [x] Correct sequencing of dependencies (deps should always be opt. Maybe make everything opt?)
|
|
||||||
- [x] Config in multiple files
|
|
||||||
- [x] dev option and patterns for local packages
|
|
||||||
- [x] Profiling
|
|
||||||
- [x] lockfile `lazy-lock.json`
|
|
||||||
- [x] upvalues in `config` & `init`
|
|
||||||
- [x] automatically check for updates
|
|
||||||
- [x] commit, branch, tag, version and full semver support
|
|
||||||
- [x] statusline component to see number of pending updates
|
|
||||||
|
|
||||||
- [x] semver https://devhints.io/semver
|
|
||||||
- [x] auto-loading on completion for lazy-loaded commands
|
|
||||||
- [x] bootstrap code
|
|
||||||
- [x] Background update checker
|
|
||||||
- [x] health checks: check merge conflicts async
|
|
||||||
- [x] unsupported props or props from other managers
|
|
||||||
- [x] other packages still in site?
|
|
||||||
- [x] other package manager artifacts still present? compiled etc
|
|
||||||
- [x] status page showing running handlers and cache stats
|
|
||||||
- [x] temp colorscheme used during startup when installing missing plugins
|
|
||||||
- [x] automatically reloads when config changes are detected
|
|
||||||
- [x] handlers imply opt
|
|
||||||
- [x] dependencies imply opt for deps
|
|
||||||
- [ ] show spec errors in health
|
|
||||||
- [ ] fix plugin details
|
|
||||||
- [ ] show disabled plugins (strikethrough?)
|
|
||||||
- [ ] log file
|
|
||||||
- [ ] git tests
|
|
||||||
- [ ] Import specs from other plugin managers
|
|
||||||
- [ ] [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?
|
|
||||||
- [ ] package meta index (package.lua cache for all packages)
|
|
||||||
|
|
||||||
## Profiler
|
## Profiler
|
||||||
|
|
||||||
|
The profiling view shows you why and how long it took to load your plugins.
|
||||||
|
|
||||||
![image](https://user-images.githubusercontent.com/292349/207703263-3b38ca45-9779-482b-b684-4f8c3b3e76d0.png)
|
![image](https://user-images.githubusercontent.com/292349/207703263-3b38ca45-9779-482b-b684-4f8c3b3e76d0.png)
|
||||||
|
|
||||||
|
## Debug
|
||||||
|
|
||||||
|
See an overview of active lazy-loading handlers and what's in the module cache
|
||||||
|
|
||||||
![image](https://user-images.githubusercontent.com/292349/207703522-8bb20678-bb4c-4424-80e4-add3219711c3.png)
|
![image](https://user-images.githubusercontent.com/292349/207703522-8bb20678-bb4c-4424-80e4-add3219711c3.png)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 📦 Differences with Packer
|
## 📦 Differences with Packer
|
||||||
|
|
||||||
- **Plugin Spec**:
|
- **Plugin Spec**:
|
||||||
|
|
|
@ -0,0 +1,44 @@
|
||||||
|
## ✅ TODO
|
||||||
|
|
||||||
|
- [x] fancy UI to manage all your Neovim plugins
|
||||||
|
- [x] auto lazy-loading of lua modules
|
||||||
|
- [x] lazy-loading on events, commands, filetypes and key mappings
|
||||||
|
- [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 to manually compile
|
||||||
|
- [x] Fast. Automatically caches and compiles byte code of all lua modules needed during startup
|
||||||
|
- [x] Correct sequencing of dependencies (deps should always be opt. Maybe make everything opt?)
|
||||||
|
- [x] Config in multiple files
|
||||||
|
- [x] dev option and patterns for local packages
|
||||||
|
- [x] Profiling
|
||||||
|
- [x] lockfile `lazy-lock.json`
|
||||||
|
- [x] upvalues in `config` & `init`
|
||||||
|
- [x] automatically check for updates
|
||||||
|
- [x] commit, branch, tag, version and full semver support
|
||||||
|
- [x] statusline component to see number of pending updates
|
||||||
|
|
||||||
|
- [x] semver https://devhints.io/semver
|
||||||
|
- [x] auto-loading on completion for lazy-loaded commands
|
||||||
|
- [x] bootstrap code
|
||||||
|
- [x] Background update checker
|
||||||
|
- [x] health checks: check merge conflicts async
|
||||||
|
- [x] unsupported props or props from other managers
|
||||||
|
- [x] other packages still in site?
|
||||||
|
- [x] other package manager artifacts still present? compiled etc
|
||||||
|
- [x] status page showing running handlers and cache stats
|
||||||
|
- [x] temp colorscheme used during startup when installing missing plugins
|
||||||
|
- [x] automatically reloads when config changes are detected
|
||||||
|
- [x] handlers imply opt
|
||||||
|
- [x] dependencies imply opt for deps
|
||||||
|
- [ ] show spec errors in health
|
||||||
|
- [ ] fix plugin details
|
||||||
|
- [ ] show disabled plugins (strikethrough?)
|
||||||
|
- [ ] log file
|
||||||
|
- [ ] git tests
|
||||||
|
- [ ] Import specs from other plugin managers
|
||||||
|
- [ ] [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?
|
||||||
|
- [ ] package meta index (package.lua cache for all packages)
|
Loading…
Reference in New Issue