feat: new setup options, docs fixed, CI improvements

Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>

Author: DrKJeff16

README.md

@@ -14,6 +14,9 @@ Toggle `true` and `false` values under your cursor.
   - [`paq-nvim`](#paq-nvim)
   - [`vim.pack`](#vimpack)
   - [LuaRocks](#luarocks)
+- [Configuration](#configuration)
+  - [Defaults](#defaults)
+- [License](#license)
 
 ---
 
@@ -126,7 +129,11 @@ By default, `setup()` loads with the following options:
 
 ```lua
 {
-  auto_write = false, -- Whether to automatically save the file when a boolean is changed
+  -- Whether to automatically save the file when a boolean is changed
+  auto_write = false,
+
+  -- A list of strings with the filetypes for which this plugin will be deactivated
+  ignore_ft = {}
 
   -- Normal mode keymaps
   --
@@ -148,4 +155,8 @@ By default, `setup()` loads with the following options:
 
 ---
 
+## License
+
+[GPLv2](https://github.com/DrKJeff16/boolean-toggle.nvim/blob/main/LICENSE)
+
 <!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->

lua/boolean-toggle.lua

@@ -91,11 +91,7 @@ function M.setup(opts)
     end
   end
 
-  vim.api.nvim_create_user_command(
-    'Bool',
-    M.cursor_toggle_boolean,
-    { desc = 'Invert Boolean Value on Cursor' }
-  )
+  vim.api.nvim_create_user_command('Bool', M.cursor_toggle_boolean, { desc = 'Invert Boolean Value on Cursor' })
 end
 
 ---@return boolean is_boolean
@@ -133,8 +129,20 @@ function M.boolean_under_cursor()
 end
 
 function M.cursor_toggle_boolean()
+  local bufnr = vim.api.nvim_get_current_buf()
   local ok, start_col, end_col = M.boolean_under_cursor()
-  if not (ok and start_col and end_col) then
+  if
+    not (
+      ok
+      and start_col
+      and end_col
+      and vim.list_contains({ 'acwrite', '' }, vim.api.nvim_get_option_value('buftype', { buf = bufnr }))
+    )
+  then
+    return
+  end
+
+  if vim.list_contains(Config.config.ignore_ft, vim.api.nvim_get_option_value('filetype', { buf = bufnr })) then
     return
   end
 
@@ -161,8 +169,20 @@ function M.cursor_toggle_boolean()
 end
 
 function M.cursor_set_to_false()
+  local bufnr = vim.api.nvim_get_current_buf()
   local ok, start_col, end_col = M.boolean_under_cursor()
-  if not (ok and start_col and end_col) then
+  if
+    not (
+      ok
+      and start_col
+      and end_col
+      and vim.list_contains({ 'acwrite', '' }, vim.api.nvim_get_option_value('buftype', { buf = bufnr }))
+    )
+  then
+    return
+  end
+
+  if vim.list_contains(Config.config.ignore_ft, vim.api.nvim_get_option_value('filetype', { buf = bufnr })) then
     return
   end
 
@@ -176,8 +196,7 @@ function M.cursor_set_to_false()
   local pos = vim.api.nvim_win_get_cursor(win)
   local before, after = get_boolean_surround(line, start_col, end_col)
   if not vim.list_contains({ 't', 'T' }, line:sub(pos[2] + 1, pos[2] + 1)) then
-    pos[2] = pos[2]
-      + (line:len() > (before .. convert_to_false[current_bool] .. after):len() and -1 or 1)
+    pos[2] = pos[2] + (line:len() > (before .. convert_to_false[current_bool] .. after):len() and -1 or 1)
   end
 
   vim.api.nvim_set_current_line(before .. convert_to_false[line:sub(start_col, end_col)] .. after)
@@ -190,8 +209,20 @@ function M.cursor_set_to_false()
 end
 
 function M.cursor_set_to_true()
+  local bufnr = vim.api.nvim_get_current_buf()
   local ok, start_col, end_col = M.boolean_under_cursor()
-  if not (ok and start_col and end_col) then
+  if
+    not (
+      ok
+      and start_col
+      and end_col
+      and vim.list_contains({ 'acwrite', '' }, vim.api.nvim_get_option_value('buftype', { buf = bufnr }))
+    )
+  then
+    return
+  end
+
+  if vim.list_contains(Config.config.ignore_ft, vim.api.nvim_get_option_value('filetype', { buf = bufnr })) then
     return
   end
 
@@ -205,8 +236,7 @@ function M.cursor_set_to_true()
   local pos = vim.api.nvim_win_get_cursor(win)
   local before, after = get_boolean_surround(line, start_col, end_col)
   if not vim.list_contains({ 't', 'T' }, line:sub(pos[2] + 1, pos[2] + 1)) then
-    pos[2] = pos[2]
-      + (line:len() > (before .. convert_to_true[current_bool] .. after):len() and -1 or 1)
+    pos[2] = pos[2] + (line:len() > (before .. convert_to_true[current_bool] .. after):len() and -1 or 1)
   end
 
   vim.api.nvim_set_current_line(before .. convert_to_true[line:sub(start_col, end_col)] .. after)
@@ -218,7 +248,5 @@ function M.cursor_set_to_true()
   end
 end
 
-function M.setup_keymaps() end
-
 return M
 -- vim: set ts=2 sts=2 sw=2 et ai si sta:

lua/boolean-toggle/config.lua

@@ -1,5 +1,3 @@
-local Util = require('boolean-toggle.util')
-
 ---@class BooleanToggleOpts.Keymaps
 ---@field to_false? string|nil
 ---@field to_true? string|nil
@@ -12,12 +10,16 @@ local Util = require('boolean-toggle.util')
 
 ---@class BooleanToggleOpts
 ---@field auto_write? boolean
+---@field ignore_ft? string[]
 ---@field keymaps? BooleanToggleOpts.Keymaps|nil
 
 ---@class BooleanToggleDefaults: BooleanToggleOpts
 ---@field auto_write boolean
+---@field ignore_ft string[]
 ---@field keymaps BooleanToggleDefaults.Keymaps
 
+local Util = require('boolean-toggle.util')
+
 ---@class BooleanToggle.Config
 ---@field config BooleanToggleDefaults
 local M = {}
@@ -26,6 +28,7 @@ local M = {}
 function M.get_defaults()
   return { ---@type BooleanToggleDefaults
     auto_write = false,
+    ignore_ft = {},
     keymaps = { toggle = nil, to_false = nil, to_true = nil },
   }
 end

stylua.toml

@@ -1,6 +1,6 @@
 call_parentheses = "Always"
 collapse_simple_statement = "Never"
-column_width = 100
+column_width = 120
 indent_type = "Spaces"
 indent_width = 2
 line_endings = "Unix"