Merge pull request #17 from Hashino/next

v0.3

README.md

@@ -19,6 +19,7 @@ It works by storing the tasks in a plain text file
 this plugin was originally a fork of [nocksock/do.nvim](https://github.com/nocksock/do.nvim)
 
 ![doing](https://raw.githubusercontent.com/Hashino/doing.nvim/main/demo.gif)
+*the gif was recorded using a [custom heirline component](https://github.com/Hashino/hash.nvim/blob/be72be47cb150019ce585a7c0f9e0060db0de76d/lua/hash/plugins/interface/status-bar.lua#L176-L222)*
 
 ## Commands
 
@@ -81,6 +82,9 @@ lazy.nvim:
       -- if should append "+n more" to the status when there's tasks remaining
       show_remaining = true,
 
+      -- if should show messages on the status string
+      show_messages = true,
+
       -- window configs of the floating tasks editor
       -- see :h nvim_open_win() for available options
       edit_win_config = {

lua/doing/config.lua

@@ -11,8 +11,8 @@ local Config = {}
 ---@field show_remaining boolean show "+n more" when there are more than 1 tasks
 ---@field edit_win_config vim.api.keyset.win_config window configs of the floating editor
 
+---@class DoingOptions
 Config.default_opts = {
-  message_timeout = 2000,
   doing_prefix = "Doing: ",
 
   -- doesn"t display on buffers that match filetype/filename/filepath to
@@ -24,7 +24,10 @@ Config.default_opts = {
   show_remaining = true,
 
   -- if should show messages on the status string
+  -- if true, the status will show a message for the duration 
+  -- of message_timeout in the status string
   show_messages = true,
+  message_timeout = 2000,
 
   winbar = {
     enabled = true, -- if plugin should manage the winbar

lua/doing/utils.lua

@@ -34,6 +34,7 @@ function Utils.should_display()
   local home_path_abs = tostring(os.getenv("HOME"))
   local curr = vim.fn.expand("%:p")
 
+  ---@diagnostic disable-next-line: param-type-mismatch
   for _, exclude in ipairs(ignore) do
     -- checks if exclude is a relative filepath and expands it
     if exclude:sub(1, 2) == "./" or exclude:sub(1, 2) == ".\\" then
@@ -91,9 +92,9 @@ function Utils.get_path_separator()
   return dir_separator
 end
 
---- calls vim.notify with a title and icon
+--- calls vim.notify with a styled title and icon
 ---@param msg string the message to show
----@param log_level? integer the log level to show
+---@param log_level? integer One of the values from |vim.log.levels|.
 function Utils.notify(msg, log_level)
   vim.notify(msg, log_level or vim.log.levels.OFF,
     { title = "doing.nvim", icon = "", })