feat(log): add node inspection function #2541
Conversation
There was a problem hiding this comment.
I like the idea - it will be most useful to have something that I always end up adding log lines for.
I am a bit hesitant:
- Inspecting nodes is massive as it goes up and down the tree.
- I don't want to encourage users to look into nodes. They are private and definitely shouldn't be mutated.
How about:
- Change this to log raw instead of print
- Accept an
optionsparameter to pass directly to vim.inspect
|
RE 2. I wish we'd never let the nodes escape into public API. I'd like to provide a sanitised copy of nodes like |
|
I understand your concerns
This can be a good idea, but I don't know if it should go in the API, I'd rather put it in the |
Ah, that would work nicely. I imagine myself doing something like this in an event or mapping: local log = require("nvim-tree.log")
log.node("dev", node, "Event.NodeRenamed %s", data.new_name)I'm happy with your best judgement. This will be useful. |
| local inspect_opts = {} | ||
|
|
||
| --- @param opts table | ||
| function M.set_inspect_opts(opts) |
There was a problem hiding this comment.
Since the inspect options are rarely changed, I chose to add this little function to set them instead of another parameter to the node function.
Akmadan23
changed the title
api.tree.inspect_node_under_cursor
| --- @vararg any arguments for string.format | ||
| function M.node(typ, node, fmt, ...) | ||
| if M.enabled(typ) then | ||
| node = node or require("nvim-tree.lib").get_node_at_cursor() |
Oh, it's really no different to me, just merge whenever you feel like the PR is ready |
I am also happy either way. |
I often use this little function, exposing it in the api might be useful to someone.