chore: add info on case-sensitivity of sources

chrisgrieser · Sep 22, 2023 · a1d8245 · a1d8245
1 parent c406c3e
commit a1d8245
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -27,14 +27,14 @@ You easily add a custom source via the [plugin configuration](#configuration). T
 <!-- INFO use `make update_readme` to automatically update this section -->
 <!-- auto-generated: start -->
 ### Rule Lookup
-- `Lua Diagnostics`
 - `eslint`
 - `shellcheck`
 - `biome`
 - `selene`
 - `pylint`
 - `yamllint`
 - `stylelint`
+- `Lua Diagnostics`
 
 ### Add Ignore Comments
 - [eslint](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1)

diff --git a/lua/rulebook/rule-data.lua b/lua/rulebook/rule-data.lua
@@ -10,6 +10,7 @@ local M = {}
 -- one to be inserted after. (prevLine or sameLine comments are obviously
 -- preferred, but some linters to do support that.)
 
+---INFO the key must be named exactly like diagnostic.source (case-sensitive!) 
 ---@type table<string, ruleIgnoreConfig>
 M.ignoreComments = {
 	shellcheck = {
@@ -71,6 +72,7 @@ M.ignoreComments = {
 
 --------------------------------------------------------------------------------
 
+---INFO the key must be named exactly like diagnostic.source (case-sensitive!) 
 -- "%s" will be replaced with the rule id
 ---@type table<string, string>
 M.ruleDocs = {