Skip to content

feat(log): add node inspection function #2541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 25, 2023
Merged

feat(log): add node inspection function #2541

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
784ee91
feat: add `api.tree.inspect_node_under_cursor`
Akmadan23 Nov 19, 2023
6dc396d
Add documentation
Akmadan23 Nov 19, 2023
2b16fc2
Revert "feat: add `api.tree.inspect_node_under_cursor`"
Akmadan23 Nov 21, 2023
0aac1a3
Revert "Add documentation"
Akmadan23 Nov 21, 2023
6acac20
feat(log): add node inspection function
Akmadan23 Nov 23, 2023
9802d93
Merge branch 'master' into api-add-tree.inspect_node_under_cursor
Akmadan23 Nov 23, 2023
03b35aa
Merge branch 'master' into api-add-tree.inspect_node_under_cursor
alex-courtis Nov 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions lua/nvim-tree/log.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,26 @@ function M.line(typ, fmt, ...)
end
end

local inspect_opts = {}

--- @param opts table
function M.set_inspect_opts(opts)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

inspect_opts = opts
end

--- Write to log file the inspection of a node
--- defaults to the node under cursor if none is provided
--- @param typ string as per log.types config
--- @param node table|nil node to be inspected
--- @param fmt string for string.format
--- @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()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is very handy...

M.raw(typ, string.format("[%s] [%s] %s\n%s\n", os.date "%Y-%m-%d %H:%M:%S", typ, (fmt or "???"), vim.inspect(node, inspect_opts)), ...)
end
end

--- Logging is enabled for typ or all
--- @param typ string as per log.types config
--- @return boolean
Expand Down