benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-01 11:06:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
nvim-treesitter/TODO.md

32 lines
1.4 KiB
Markdown
Raw Normal View History

feat!: drop modules, general refactor and cleanup
2023-06-12 09:54:30 -06:00
# Roadmap
This document lists the planned and finished changes in this rewrite towards [Nvim-treesitter 1.0](https://github.com/nvim-treesitter/nvim-treesitter/issues/4767).
## TODO
feat(tests)!: new infrastructure based on makefile Problem: Not easy to run all checks and tests locally. Redundant CI workflows. Solution: Separate CI into two workflows: * lint: Lua files (stylua, luals), query files (valid captures, predicates, directives using tsqueryls), docs (SUPPORTED_LANGUAGES.md) -- does not need parser installation * tests: parsers (ABI compatibility), query files (tsqueryls on Linux/macOS; nvim on Windows), highlight and indent tests (separated for better readability) -- needs parser installation (but only once) Switch to https://github.com/nvim-treesitter/highlight-assertions fork with ABI 15 support. Run all tests (on Linux and macOS) through `make` (`formatlua`, `checklua`, `lintquery`, `formatquery`, `checkquery`, `docs`, `tests`), which downloads and caches all necessary dependencies. Remove `update-readme` workflow (replaced by lint job on PRs).
2025-04-29 19:40:18 +02:00
- [ ] **`parsers.lua`:** track versioned releases for tier 1
feat(install)!: drop support for git Problem: Using git for installing parsers can lead to data loss if in a git commit buffer. Solution: Only support downloading via curl+tar, which are installed on all supported platforms (since Windows 10). Curl will also be required for WASM parsers (and for `vim.net.download()`).
2024-06-13 12:30:57 +02:00
- [ ] **`parsers.lua`:** add WASM support (tier 1)
feat(parsers): rework tiers * stable: updates follow semver releases (todo) * unstable: updates follow HEAD (default) * unmaintained: no automatic updates * unsupported: no updates, cannot be installed
2025-02-09 13:19:34 +01:00
- [ ] **`install.lua`:** migrate to async v2
feat(tests)!: new infrastructure based on makefile Problem: Not easy to run all checks and tests locally. Redundant CI workflows. Solution: Separate CI into two workflows: * lint: Lua files (stylua, luals), query files (valid captures, predicates, directives using tsqueryls), docs (SUPPORTED_LANGUAGES.md) -- does not need parser installation * tests: parsers (ABI compatibility), query files (tsqueryls on Linux/macOS; nvim on Windows), highlight and indent tests (separated for better readability) -- needs parser installation (but only once) Switch to https://github.com/nvim-treesitter/highlight-assertions fork with ABI 15 support. Run all tests (on Linux and macOS) through `make` (`formatlua`, `checklua`, `lintquery`, `formatquery`, `checkquery`, `docs`, `tests`), which downloads and caches all necessary dependencies. Remove `update-readme` workflow (replaced by lint job on PRs).
2025-04-29 19:40:18 +02:00
- [ ] **tests:** remove custom crate, plenary dependency
feat!: drop modules, general refactor and cleanup
2023-06-12 09:54:30 -06:00
- [ ] **documentation:** consolidate, autogenerate?
- [ ] **documentation:** migration guide
feat(tests)!: new infrastructure based on makefile Problem: Not easy to run all checks and tests locally. Redundant CI workflows. Solution: Separate CI into two workflows: * lint: Lua files (stylua, luals), query files (valid captures, predicates, directives using tsqueryls), docs (SUPPORTED_LANGUAGES.md) -- does not need parser installation * tests: parsers (ABI compatibility), query files (tsqueryls on Linux/macOS; nvim on Windows), highlight and indent tests (separated for better readability) -- needs parser installation (but only once) Switch to https://github.com/nvim-treesitter/highlight-assertions fork with ABI 15 support. Run all tests (on Linux and macOS) through `make` (`formatlua`, `checklua`, `lintquery`, `formatquery`, `checkquery`, `docs`, `tests`), which downloads and caches all necessary dependencies. Remove `update-readme` workflow (replaced by lint job on PRs).
2025-04-29 19:40:18 +02:00
- [ ] **indents:** rewrite (Helix or Zed compatible)
feat(install)!: drop support for git Problem: Using git for installing parsers can lead to data loss if in a git commit buffer. Solution: Only support downloading via curl+tar, which are installed on all supported platforms (since Windows 10). Curl will also be required for WASM parsers (and for `vim.net.download()`).
2024-06-13 12:30:57 +02:00
- [ ] **textobjects:** include simple(!) `node`, `scope` (using `locals`) objects
feat!: drop modules, general refactor and cleanup
2023-06-12 09:54:30 -06:00
## DONE
- [X] remove module framework
- [X] remove extra utilities
- [X] refactor `indent.lua` into standalone
feat(locals)!: refactor `locals.lua` into standalone Co-authored-by: TheLeoP <eugenio2305@hotmail.com>
2023-05-20 17:29:03 +02:00
- [X] refactor `locals.lua` into standalone
feat!: drop modules, general refactor and cleanup
2023-06-12 09:54:30 -06:00
- [X] refactor commands, predicates, filetypes registration to plugin/
- [X] support installing tiers of parsers
- [X] install parsers to standard directory by default
- [X] remove bundled queries from runtimepath; copy on parser install
- [X] general refactor and cleanup
refactor: rewrite installation using jobs and async Replace sync variants with callback support
2023-05-22 14:35:25 +01:00
- [X] rewrite installation using async module (drop support for sync; use callback instead)
feat(locals)!: refactor `locals.lua` into standalone Co-authored-by: TheLeoP <eugenio2305@hotmail.com>
2023-05-20 17:29:03 +02:00
- [X] switch to upstream injection format
feat!: drop modules, general refactor and cleanup
2023-06-12 09:54:30 -06:00
- [X] remove locals from highlighting (cf. https://github.com/nvim-treesitter/nvim-treesitter/issues/3944#issuecomment-1458782497)
feat(setup)!: remove ensure_install field Instead, call `require('nvim-treesitter').install( { ... } )` manually. This gives users full control over how they want to install parsers (sync, from grammar, limited concurrency) and obviates the need for calling `setup` for most users.
2025-04-27 13:02:32 +02:00
- [X] drop ensure_install (replace with install)
feat(tests)!: new infrastructure based on makefile Problem: Not easy to run all checks and tests locally. Redundant CI workflows. Solution: Separate CI into two workflows: * lint: Lua files (stylua, luals), query files (valid captures, predicates, directives using tsqueryls), docs (SUPPORTED_LANGUAGES.md) -- does not need parser installation * tests: parsers (ABI compatibility), query files (tsqueryls on Linux/macOS; nvim on Windows), highlight and indent tests (separated for better readability) -- needs parser installation (but only once) Switch to https://github.com/nvim-treesitter/highlight-assertions fork with ABI 15 support. Run all tests (on Linux and macOS) through `make` (`formatlua`, `checklua`, `lintquery`, `formatquery`, `checkquery`, `docs`, `tests`), which downloads and caches all necessary dependencies. Remove `update-readme` workflow (replaced by lint job on PRs).
2025-04-29 19:40:18 +02:00
- [X] **CI:** switch to ts_query_ls, add update readme as check (remove update job)
Reference in a new issue Copy permalink