feat: add diagnostic_opts parameter

Resolves #6

README.md

@@ -50,9 +50,10 @@ Pass any of the following options to `require("spellwarn").setup()`:
         spellrare  = "INFO",
     },
     prefix = "possible misspelling(s): ", -- prefix for each diagnostic message
+    diagnostic_opts = { severity_sort = true }, -- options for diagnostic display
 }
 ```
-Most options are overwritten (e.g. passing `ft_config = { python = false }` will mean that `alpha`, `mason`, etc. are set to true) but `severity` is merged, so that passing `spellbad = "HINT"` won't cause `spellcap` to be nil. You can pass any of `cursor`, `iter`, `treesitter`, `false`, or `true` as options to `ft_config`. The default method is `cursor`, which iterates through the buffer with `]s`. There is also `iter`, which uses Treesitter (if available) and the Lua API. Finally, `false` disables Spellwarn for that filetype and `true` uses the default (`cursor`).
+Most options are overwritten (e.g. passing `ft_config = { python = false }` will mean that `alpha`, `mason`, etc. are set to true) but `severity` and `diagnostic_opts` are merged, so that (for example) passing `{ spellbad = "HINT" }` won't cause `spellcap` to be nil. You can pass any of `cursor`, `iter`, `treesitter`, `false`, or `true` as options to `ft_config`. The default method is `cursor`, which iterates through the buffer with `]s`. There is also `iter`, which uses Treesitter (if available) and the Lua API. Finally, `false` disables Spellwarn for that filetype and `true` uses the default (`cursor`).
 
 *Note: `iter` doesn't show `spellcap` errors, but works well other than that. I recommend it.*
 

lua/spellwarn/diagnostics.lua

@@ -36,7 +36,7 @@ function M.update_diagnostics(opts, bufnr)
     end
     vim.diagnostic.reset(namespace, bufnr)
     -- TODO: Add suffix diagnostics with type of spelling error the way that LSP diagnostics do
-    vim.diagnostic.set(namespace, bufnr, diags, { severity_sort = true })
+    vim.diagnostic.set(namespace, bufnr, diags, opts.diagnostic_opts)
 end
 
 function M.setup(opts)

lua/spellwarn/init.lua

@@ -25,13 +25,16 @@ local defaults = {
         spellrare  = "INFO",
     },
     prefix = "possible misspelling(s): ", -- prefix for each diagnostic message
+    diagnostic_opts = { severity_sort = true }, -- options for diagnostic display
 }
 
 function M.setup(opts)
-    -- With most options we want to overwrite the defaults, but with `severity` we want to extend
+    -- With most options we want to overwrite the defaults, but with `severity` and `diagnostic_opts` we want to extend
+    local diagnostic_opts = defaults.diagnostic_opts
     local severity = defaults.severity
     opts = opts or {}
     defaults = vim.tbl_extend("force", defaults, opts)
+    defaults.diagnostic_opts = vim.tbl_extend("force", diagnostic_opts, opts.diagnostic_opts or {})
     defaults.severity = vim.tbl_extend("force", severity, opts.severity or {})
     require("spellwarn.diagnostics").setup(defaults)