diff --git a/README.md b/README.md index d2d8b23..d81c35e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# nvim-rule-breaker +# nvim-rulebook - + Add inline-comments to locally disable diagnostic rules. @@ -36,28 +36,28 @@ Most LSPs provide code actions for to do that – this plugin adds commands for You easily add a custom via the [plugin configuration](#configuration). However, please consider making a PR to add support for a linter if it is missing. -[Ignore Rule Data for the supported linters](./lua/rule-breaker/ignoreRuleData.lua) +[Ignore Rule Data for the supported linters](./lua/rulebook/ignoreRuleData.lua) ## Installation ```lua -- lazy.nvim { - "chrisgrieser/nvim-rule-breaker", + "chrisgrieser/nvim-rulebook", keys = { - { "i", function() require("rule-breaker").ignoreRule() end }, - { "l", function() require("rule-breaker").lookupRule() end }, + { "i", function() require("rulebook").ignoreRule() end }, + { "l", function() require("rulebook").lookupRule() end }, } }, ``` ```lua -- packer -use { "chrisgrieser/nvim-rule-breaker" } +use { "chrisgrieser/nvim-rulebook" } -- in your config -vim.keymap.set("n", "i", function() require("rule-breaker").ignoreRule() end) -vim.keymap.set("n", "l", function() require("rule-breaker").lookupRule() end) +vim.keymap.set("n", "i", function() require("rulebook").ignoreRule() end) +vim.keymap.set("n", "l", function() require("rulebook").lookupRule() end) ``` ## Configuration diff --git a/doc/rule-breaker.txt b/doc/rulebook.txt similarity index 100% rename from doc/rule-breaker.txt rename to doc/rulebook.txt diff --git a/lua/rule-breaker/init.lua b/lua/rulebook/init.lua similarity index 100% rename from lua/rule-breaker/init.lua rename to lua/rulebook/init.lua diff --git a/lua/rule-breaker/ignoreRuleData.lua b/lua/rulebook/rule-data.lua similarity index 100% rename from lua/rule-breaker/ignoreRuleData.lua rename to lua/rulebook/rule-data.lua diff --git a/lua/rule-breaker/types.lua b/lua/rulebook/types.lua similarity index 100% rename from lua/rule-breaker/types.lua rename to lua/rulebook/types.lua