Logsitter

A Treesitter-based, Turbo Console Log-inspired, lua-written, NeoVim plugin.

Makes debugging easier by automating the process of writing log messages.

Install

With Lazy:

{"gaelph/logsitter.nvim", dependencies = {"nvim-treesitter/nvim-treesitter"}}

-- with an optional config
{
	"gaelph/logsitter.nvim",
	dependencies = {"nvim-treesitter/nvim-treesitter"},
	config = function()
		require("logsitter").setup({
			path_format = "default",
			prefix = "[LS] ->",
			separator = "->",
		})
	end
}

Supported Languages

- Javascript/Typescript and Svelte/Vue/Astro (`console.log()`)
- Golang (`log.Println("... %+v\n", ...)`)
- Lua (`print()`)

Experimental support for:

- Python (`print()`)
- Swift (`print()`)

Example usage

lua:

vim.api.nvim_create_augroup("LogSitter", { clear = true })
vim.api.nvim_create_autocmd("FileType", {
	group = "Logsitter",
	pattern = "javascript,go,lua",
	callback = function()
		vim.keymap.set("n", "<localleader>lg", function()
			require("logsitter").log()
		end)

		-- experimental visual mode
		vim.keymap.set("x", "<localleader>lg", function()
			require("logsitter").log_visual()
		end)
	end,
})

There is also a lua function:

require("logsitter").log()

To use Logsitter with other file types:

-- This can go in after/ftplugin/svelte.lua
local logsitter = require("logsitter")
local javascript_logger = require("logsitter.lang.javascript")

-- tell logsitter to use the javascript_logger when the filetype is svelte
logsitter.register(javascript_logger, { "svelte" })

vim.keymap.set("n", "<localleader>lg", function()
	logsitter.log()
end)

Commands

• LogsitterClearBuf: Removes all log statements inserted with logsitter in the current buffer.
• LogsitterClearAll: Removes all log statements inserted with logsitter in all files in the current working directory. It does so using :grep, so you can use rg or other grep alternatives to make the process faster.

Configuration

These are the default configuration values:

local DefaultOptions = {
	-- Format for the file name.
	-- Available values:
	-- - "default":  path to file relative to the current working directory
	-- - "short":    shortened path (with the builtin `pathshorten()` function)
	-- - "fileonly": only display the file name
	path_format = "default",
	-- The prefix for the log message. Can be an emoji like "🚀"
	prefix = "[LS] ->",
	-- The separator between the file path and the displayed value
	separator = "->",
}

License

MIT