nvim-tree / nvim-tree/nvim-tree.lua
Full And Sanitized Node Documentation
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 8.6k
- Forks
- 639
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
Is this a question?
No
Can this functionality be implemented utilizing API?
Not a functionality per say.
Is your feature request related to a problem? Please describe.
Many functions of the API retrieves nodes such as get_node_under_cursor().
There doesn't seem to be any documentation about the structure of a node except in the sort API section. But there are some missing fields in the doc.
Describe the solution you'd like
It would be nice to have a small section of the documentation dedicated to the content of a node. This would make it officially part of the API.
Describe alternatives you've considered
Check the node builder source code but that does not prevent invisible breaking changes to the node API.
Additional context
This issue is raised after a short post on reddit.
I don't know if this qualifies as a feature request, feel free to move it around.
nvim-tree is an awesome plugin and you did a really good job.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the node structure shown in the sort API section of doc/nvim-tree-lua.txt and compare it with lua/nvim-tree/explorer/node-builders.lua. Document the full and sanitized node contents as part of the API, including the fields found during that comparison; done means the documentation clearly describes both node forms and their supported fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100