Skip to content

Commit

Permalink
feat!: set show_warnings = false by default
Browse files Browse the repository at this point in the history
Closes #31
  • Loading branch information
mawkler committed Mar 5, 2024
1 parent d35bb7c commit 0140310
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
21 changes: 17 additions & 4 deletions README.md
Expand Up @@ -36,7 +36,13 @@ With [lazy.nvim](https://github.com/folke/lazy.nvim/):
vim.o.number = true
vim.o.termguicolors = true
end,
opts = {}
opts = {
-- Warn if any required option above is missing. May emit false positives
-- if some other plugin modifies them, which in that case you can just
-- ignore. Feel free to remove this line after you've gotten Modicator to
-- work properly.
show_warnings = true,
}
}
```

Expand All @@ -53,7 +59,13 @@ use {
vim.o.termguicolors = true
end,
config = function()
require('modicator').setup()
require('modicator').setup({
-- Warn if any required option above is missing. May emit false positives
-- if some other plugin modifies them, which in that case you can just
-- ignore. Feel free to remove this line after you've gotten Modicator to
-- work properly.
show_warnings = true,
})
end
}
```
Expand All @@ -79,8 +91,9 @@ For more information on how to create a highlight group, see `:help nvim_set_hl`

```lua
require('modicator').setup({
-- Show warning if any required option is missing
show_warnings = true,
-- Warn if any required option is missing. May emit false positives if some
-- other plugin modifies them, which in that case you can just ignore
show_warnings = false,
highlights = {
-- Default options for bold/italic
defaults = {
Expand Down
2 changes: 1 addition & 1 deletion lua/modicator/init.lua
Expand Up @@ -13,7 +13,7 @@ local M = {}
--- @field integration? { lualine?: ModicatorLualineIntegration }
local options = {
--- @type boolean
show_warnings = true,
show_warnings = false,
highlights = {
defaults = {
bold = false,
Expand Down

0 comments on commit 0140310

Please sign in to comment.