Change util.log to not write to a file by default

Author: aaronik

checks/rogue_util_calls_spec.lua

@@ -2,56 +2,56 @@
 -- util functions like R and log. This isn't perfect, as it tries to exercise
 -- each command, but doesn't seek edge cases.
 
-local load_fixture = require "tests.load_fixture"
-local assert = require 'luassert'
-local stub = require 'luassert.stub'
-local util = require 'treewalker.util'
+local load_fixture = require("tests.load_fixture")
+local assert = require("luassert")
+local stub = require("luassert.stub")
+local util = require("treewalker.util")
 
 local commands = {
-  "Treewalker Up",
-  "Treewalker Down",
-  "Treewalker Right",
-  "Treewalker Left",
-  "Treewalker SwapUp",
-  "Treewalker SwapDown",
-  "Treewalker SwapRight",
-  "Treewalker SwapLeft",
+	"Treewalker Up",
+	"Treewalker Down",
+	"Treewalker Right",
+	"Treewalker Left",
+	"Treewalker SwapUp",
+	"Treewalker SwapDown",
+	"Treewalker SwapRight",
+	"Treewalker SwapLeft",
 }
 
 -- can't get luassert (plenary) spy working
 -- This needs to be generic over obj but can't figure out that either
 ---@param obj table
 ---@param method string
 local function spy(obj, method)
-  local orig = obj[method]
-  local stoob = stub.new(obj, method)
-  stoob.callback = orig
-  ---@type type obj
-  return stoob
+	local orig = obj[method]
+	local stoob = stub.new(obj, method)
+	stoob.callback = orig
+	---@type type obj
+	return stoob
 end
 
 describe("Extent util calls:", function()
-  local util_R_stub = spy(util, "R")
-  local util_log_stub = spy(util, "log")
-
-  -- Simulate TREEWALKER_NVIM_ENV being set to anything other than "development", see plugin/init.lua
-  stub(os, "getenv").returns("")
-
-  before_each(function()
-    load_fixture("/lua.lua")
-    vim.opt.fileencoding = 'utf-8'
-    vim.fn.cursor(31, 26)
-  end)
-
-  for _, command in ipairs(commands) do
-    it(command .. " encounters no " .. "util.R calls", function()
-      vim.cmd(command)
-      assert.stub(util_R_stub).was.called(0)
-    end)
-
-    it(command .. " encounters no " .. "util.log calls", function()
-      vim.cmd(command)
-      assert.stub(util_log_stub).was.called(0)
-    end)
-  end
+	local spies = {
+		spy(util, "R"),
+		spy(util, "log"),
+		spy(util, "log_file"),
+	}
+
+	-- Simulate TREEWALKER_NVIM_ENV being set to anything other than "development", see plugin/init.lua
+	stub(os, "getenv").returns("")
+
+	before_each(function()
+		load_fixture("/lua.lua")
+		vim.opt.fileencoding = "utf-8"
+		vim.fn.cursor(31, 26)
+	end)
+
+	for _, spi in ipairs(spies) do
+		for _, command in ipairs(commands) do
+			it(command .. " encounters no " .. "util.R calls", function()
+				vim.cmd(command)
+				assert.stub(spi).was.called(0)
+			end)
+		end
+	end
 end)

lua/treewalker/util.lua

@@ -3,85 +3,99 @@ local M = {}
 
 -- remove program code from lua cache, reload
 M.RELOAD = function(...)
-  return require("plenary.reload").reload_module(...)
+	return require("plenary.reload").reload_module(...)
 end
 
 -- modified 'require'; use to flush entire program from top level for plugin development.
 M.R = function(name)
-  M.RELOAD(name)
-  return require(name)
+	M.RELOAD(name)
+	return require(name)
 end
 
 -- print tables contents
 M.P = function(v)
-  print(vim.inspect(v))
-  return v
+	print(vim.inspect(v))
+	return v
 end
 
 -- Log to the file debug.log in the plugin's data dir. File can be watched for easier debugging.
-M.log = function(...)
-  local args = { ... }
-
-  -- Canonical log dir
-  local data_path = vim.fn.stdpath("data") .. "/treewalker"
-
-  -- If no dir on fs, make it
-  if vim.fn.isdirectory(data_path) == 0 then
-    vim.fn.mkdir(data_path, "p")
-  end
-
-  local log_file = io.open(data_path .. "/debug.log", "a")
-
-  -- Guard against no log file by making one
-  if not log_file then
-    log_file = io.open(data_path .. "/debug.log", "w+")
-  end
-
-  -- Swallow further errors
-  -- This is a utility for development, it should never cause issues
-  -- during real use.
-  if not log_file then return end
-
-  -- Write each arg to disk
-  for _, arg in ipairs(args) do
-    if type(arg) == "table" then
-      arg = vim.inspect(arg)
-    end
-
-    log_file:write(tostring(arg) .. "\n")
-  end
+M.log_file = function(...)
+	local args = { ... }
+
+	-- Canonical log dir
+	local data_path = vim.fn.stdpath("data") .. "/treewalker"
+
+	-- If no dir on fs, make it
+	if vim.fn.isdirectory(data_path) == 0 then
+		vim.fn.mkdir(data_path, "p")
+	end
+
+	local log_file = io.open(data_path .. "/debug.log", "a")
+
+	-- Guard against no log file by making one
+	if not log_file then
+		log_file = io.open(data_path .. "/debug.log", "w+")
+	end
+
+	-- Swallow further errors
+	-- This is a utility for development, it should never cause issues
+	-- during real use.
+	if not log_file then
+		return
+	end
+
+	-- Write each arg to disk
+	for _, arg in ipairs(args) do
+		if type(arg) == "table" then
+			arg = vim.inspect(arg)
+		end
+
+		log_file:write(tostring(arg) .. "\n")
+	end
+
+	log_file:flush() -- Ensure the output is written immediately
+	log_file:close()
+end
 
-  log_file:flush() -- Ensure the output is written immediately
-  log_file:close()
+M.log = function(...)
+	local args = { ... }
+	for _, arg in ipairs(args) do
+		if type(arg) == "table" then
+			arg = vim.inspect(arg)
+		end
+
+		-- Use vim.api.nvim_echo to print without waiting for keypress
+		vim.api.nvim_echo({ { tostring(arg) } }, true, {})
+	end
 end
 
 M.guid = function()
-  local template = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
-  return string.gsub(template, '[xy]', function(c)
-    local v = (c == 'x') and math.random(0, 0xf) or math.random(8, 0xb)
-    return string.format('%x', v)
-  end)
+	local template = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+	return string.gsub(template, "[xy]", function(c)
+		local v = (c == "x") and math.random(0, 0xf) or math.random(8, 0xb)
+		return string.format("%x", v)
+	end)
 end
 
 ---reverse an array table
 ---@param t table
-M.reverse = function (t)
-  local reversed = {}
-  for _, el in ipairs(t) do
-    table.insert(reversed, 1, el)
-  end
-  return reversed
+M.reverse = function(t)
+	local reversed = {}
+	for _, el in ipairs(t) do
+		table.insert(reversed, 1, el)
+	end
+	return reversed
 end
 
 --- Returns true if current buffer's filetype is markdown
 ---@return boolean
 M.is_markdown_file = function()
-  local ft = (
-    vim.bo and vim.bo.ft
-    or (vim.api and vim.api.nvim_buf_get_option and vim.api.nvim_buf_get_option(0, 'filetype'))
-    or ''
-  )
-  return ft == "markdown" or ft == "md"
+	local ft = (
+		vim.bo and vim.bo.ft
+		or (vim.api and vim.api.nvim_buf_get_option and vim.api.nvim_buf_get_option(0, "filetype"))
+		or ""
+	)
+	return ft == "markdown" or ft == "md"
 end
 
 return M

tests/treewalker/util_spec.lua

@@ -19,7 +19,7 @@ describe("util", function()
     end)
   end)
 
-  describe("log", function()
+  describe("log_file", function()
     it("works", function()
       local io_open_stub = stub.new(io, "open")
 
@@ -44,7 +44,7 @@ describe("util", function()
 
       io_open_stub.returns(log_file)
 
-      util.log(1, 2, 3, 4, 5)
+      util.log_file(1, 2, 3, 4, 5)
 
       assert.same({ "1\n", "2\n", "3\n", "4\n", "5\n", }, writes)
       assert.equal(1, num_flushes)