[{"result":{"data":[{"id":"c540a3b5-c4fe-4590-a2e6-8abf5c7dd454","title":"refactor!: rename plugin to `nvim-rulebook`","text":"refactor!: rename plugin to `nvim-rulebook`","type":"breaking-change","createdAt":"2023-09-23T02:10:11.229Z","breakingChange":{"id":50,"postId":"c540a3b5-c4fe-4590-a2e6-8abf5c7dd454","pluginId":204651,"externalUrl":"https://github.com/chrisgrieser/nvim-rulebook/commit/f364f37b0694cb4a49beb85422e3fa0e010abbbd","sha":"f364f37b0694cb4a49beb85422e3fa0e010abbbd","plugin":{"id":204651,"owner":"chrisgrieser","name":"nvim-rulebook","type":"github","source":"awesome-neovim","category":"diagnostics","link":"https://github.com/chrisgrieser/nvim-rulebook","shortDescription":"Add inline-comments to ignore rules, or lookup rule documentation online.","createdAt":"2023-09-23T01:39:27.244Z","readme":"\n# nvim-rulebook 📖\n\n\n\nAdd inline-comments to ignore rules, or lookup rule documentation online.\n\nSome LSPs provide code actions for that – this plugin adds commands for linters\nand LSPs that don't.\n\n\n\n- [Features](#features)\n- [Supported Sources](#supported-sources)\n\t* [Rule Lookup](#rule-lookup)\n\t* [Add Ignore Comment](#add-ignore-comment)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Customize Built-in Sources](#customize-built-in-sources)\n- [Limitations](#limitations)\n- [API](#api)\n\t* [Availability of Rule Lookup](#availability-of-rule-lookup)\n- [Credits](#credits)\n\n\n\n## Features\n- Look up official rule documentation, falling back to a web search if the\n source does not have rule documentation.\n- Add inline-comments to ignore rules like `// eslint disable-next-line\n some-rule`. Supports previous line, same line, and enclosing lines.\n- QoL: auto-select a rule if it is the only one in the current line; if the line\n has no diagnostic, search forward up to the next line that does.\n- Includes built-in support for various linters. Zero plugin configuration\n required if you only need to use built-in sources.\n- Customizing built-in sources or adding your own sources is easy. PRs to add\n more built-ins are welcome.\n\n## Supported Sources\nYou easily add a custom source via the [plugin configuration](#configuration).\nThough, please consider making a PR to add support for a source if it is\nmissing.\n\n[Rule Data for the supported linters](./lua/rulebook/data)\n\n\n\n### Rule Lookup\n- `LTeX`\n- `Lua Diagnostics.`\n- `Pyright`\n- `Ruff`\n- `biome`\n- `clang-tidy`\n- `eslint`\n- `markdownlint`\n- `pylint`\n- `selene`\n- `shellcheck`\n- `stylelint`\n- `yamllint`\n\n### Add Ignore Comment\n- [LTeX](https://valentjn.github.io/ltex/advanced-usage.html)\n- [Pyright](https://microsoft.github.io/pyright/#/comments)\n- [alex](https://github.com/get-alex/alex#control)\n- [biome](https://biomejs.dev/linter/#ignoring-code)\n- [clang-tidy](https://clang.llvm.org/extra/clang-tidy/#suppressing-undesired-diagnostics)\n- [codespell](https://github.com/codespell-project/codespell/issues/1212#issuecomment-1721152455)\n- [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker#excluding-lines)\n- [eslint](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1)\n- [pylint](https://pylint.readthedocs.io/en/latest/user_guide/messages/message_control.html)\n- [selene](https://kampfkarren.github.io/selene/usage/filtering.html#allowingdenying-lints-for-an-entire-file)\n- [shellcheck](https://www.shellcheck.net/wiki/Ignore)\n- [stylelint](https://stylelint.io/user-guide/ignore-code/)\n- [typescript](https://www.typescriptlang.org/)\n- [vale](https://vale.sh/docs/topics/config/#markup-based-configuration)\n- [woke](https://docs.getwoke.tech/ignore/#in-line-and-next-line-ignoring)\n- [yamllint](https://yamllint.readthedocs.io/en/stable/disable_with_comments.html)\n\n\n## Installation\nThis plugin requires diagnostics provided by a source that supports Neovim's\nbuilt-in diagnostics system. (nvim's built-in LSP client or\n[nvim-lint](https://github.com/mfussenegger/nvim-lint) are such sources.)\n\n```lua\n-- lazy.nvim\n{\n\t\"chrisgrieser/nvim-rulebook\",\n\tkeys = {\n\t\t{ \"i\", function() require(\"rulebook\").ignoreRule() end },\n\t\t{ \"l\", function() require(\"rulebook\").lookupRule() end },\n\t}\n},\n```\n\n```lua\n-- packer\nuse { \"chrisgrieser/nvim-rulebook\" }\n\n-- in your config\nvim.keymap.set(\"n\", \"i\", function() require(\"rulebook\").ignoreRule() end)\nvim.keymap.set(\"n\", \"l\", function() require(\"rulebook\").lookupRule() end)\n```\n\n## Configuration\nThe configuration is optional. You only need to add a config when you want to\ncustomize a source or add custom sources.\n\nWhen adding your own source, you must add the *exact*, case-sensitive\nsource-name. (for example, `clang-tidy`, not `clang`).\n\n```lua\nrequire(\"rulebook\").setup = ({\n\tignoreComments = {\n\t\tselene = {\n\t\t\tcomment = \"-- selene: allow(%s)\",\n\t\t\tlocation = \"prevLine\",\n\t\t},\n\t\t-- ... (full list of supported sources can be found in the README)\n\n\t\tyourCustomSource = { -- exact, case-sensitive source-name\n\t\t\tcomment = \"// disabling-comment %s\", -- %s will be replaced with rule-id\n\t\t\tlocation = \"prevLine\", -- \"prevLine\"|\"sameLine\"|\"encloseLine\"\n\t\t}\n\n\t\t-- if location is \"encloseLine\", needs to be a list of two strings\n\t\tanotherCustomSource = {\n\t\t\tcomment = { \"// disable-rule %s\", \"// enable-rule %s\" },\n\t\t\tlocation = \"encloseLine\",\n\t\t}\n\t},\n\n\truleDocs = {\n\t\tselene = \"https://kampfkarren.github.io/selene/lints/%s.html\"\n\t\t-- ... (full list of supported sources can be found in the README)\n\n\t\t-- Search URL when no documentation definition is available for a\n\t\t-- diagnostic source. `%s` will be replaced with the diagnostic source & code.\n\t\t-- Default is the DDG \"Ducky Search\" (automatically opening first result).\n\t\tfallback = \"https://duckduckgo.com/?q=%s+%%21ducky&kl=en-us\",\n\n\t\t-- the value of the rule documentations accept either a string or a function\n\t\t-- if a string, `%s` will be replaced with rule-id\n\t\t-- if a function, takes a `:h diagnostic-structure` as argument and must \n\t\t-- return a url\n\t\tyourCustomSource = \"https://my-docs/%s.hthml\",\n\t\tanotherCustomSource = function(diag)\n\t\t\t-- ...\n\t\t\treturn url\n\t\tend,\n\t}\n\n\t-- if no diagnostic is found in current line, search this many lines forward\n\tforwSearchLines = 10,\n})\n```\n\nThe plugin uses\n[vim.ui.select](https://neovim.io/doc/user/lua.html#vim.ui.select()), so the\nappearance of the rule selection can be customized by using a UI-plugin like\n[dressing.nvim](https://github.com/stevearc/dressing.nvim).\n\n## Customize Built-in Sources\nBuilt-in sources be customized by overwriting them in the configuration:\n\n```lua\n-- use `disable-line` instead of the default `disable-next-line` for eslint\nrequire(\"rulebook\").setup = {\n\tignoreComments = {\n\t\teslint = {\n\t\t\tcomment = \"// eslint-disable-line %s\",\n\t\t\tlocation = \"sameLine\",\n\t\t},\n\t},\n}\n```\n\n## Limitations\n- The diagnostics have to contain the necessary data, [that is a diagnostic code\n and diagnostic\n source](https://neovim.io/doc/user/diagnostic.html#diagnostic-structure). Most\n LSPs, and most linters configured for `nvim-lint` do that, but some diagnostic\n sources do not (for example `efm-langserver` with incorrectly defined\n `errorformat`). Please open an issue at the diagnostics provider to fix such\n issues.\n- This plugin does not hook into `vim.lsp.buf.code_action`, but provides its own\n selector.\n\n## API\n\n### Availability of Rule Lookup\nThe function `require(\"rulebook\").hasDocs(diag)`, expects a diagnostic object\nand returns a boolean whether `nvim-rulebook` documentation for the respective\ndiagnostic available. One use case for this is to add a visual indicator if\nthere is a rule lookup available for a diagnostic (see\n[vim.diagnostic.config](https://neovim.io/doc/user/diagnostic.html#vim.diagnostic.config())).\n\n```lua\nvim.diagnostic.config {\n\tvirtual_text = {\n\t\tsuffix = function(diag) return require(\"rulebook\").hasDocs(diag) and \"  \" or \"\" end,\n\t},\n}\n```\n\n## Credits\n\n**About Me** \nIn my day job, I am a sociologist studying the social mechanisms underlying the\ndigital economy. For my PhD project, I investigate the governance of the app\neconomy and how software ecosystems manage the tension between innovation and\ncompatibility. If you are interested in this subject, feel free to get in touch.\n\n**Blog** \nI also occasionally blog about vim: [Nano Tips for Vim](https://nanotipsforvim.prose.sh)\n\n**Profiles** \n- [reddit](https://www.reddit.com/user/pseudometapseudo)\n- [Discord](https://discordapp.com/users/462774483044794368/)\n- [Academic Website](https://chris-grieser.de/)\n- [Twitter](https://twitter.com/pseudo_meta)\n- [Mastodon](https://pkm.social/@pseudometa)\n- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)\n- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)\n\n\n","dotfyleShieldAddedAt":"2023-09-23T02:10:11.183Z","stars":50,"lastSyncedAt":"2023-11-28T02:21:12.364Z","addedLastWeek":0}}},{"id":"8cf3ac39-4533-46b1-b6ef-a95ab44dd0e1","title":"feat!: rule lookup directly at documentation sites","text":"feat!: rule lookup directly at documentation sites","type":"breaking-change","createdAt":"2023-09-23T02:10:11.229Z","breakingChange":{"id":51,"postId":"8cf3ac39-4533-46b1-b6ef-a95ab44dd0e1","pluginId":204651,"externalUrl":"https://github.com/chrisgrieser/nvim-rulebook/commit/a60690aa5e338c555e2ad53c722326f55b5c200a","sha":"a60690aa5e338c555e2ad53c722326f55b5c200a","plugin":{"id":204651,"owner":"chrisgrieser","name":"nvim-rulebook","type":"github","source":"awesome-neovim","category":"diagnostics","link":"https://github.com/chrisgrieser/nvim-rulebook","shortDescription":"Add inline-comments to ignore rules, or lookup rule documentation online.","createdAt":"2023-09-23T01:39:27.244Z","readme":"\n# nvim-rulebook 📖\n\n\n\nAdd inline-comments to ignore rules, or lookup rule documentation online.\n\nSome LSPs provide code actions for that – this plugin adds commands for linters\nand LSPs that don't.\n\n\n\n- [Features](#features)\n- [Supported Sources](#supported-sources)\n\t* [Rule Lookup](#rule-lookup)\n\t* [Add Ignore Comment](#add-ignore-comment)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Customize Built-in Sources](#customize-built-in-sources)\n- [Limitations](#limitations)\n- [API](#api)\n\t* [Availability of Rule Lookup](#availability-of-rule-lookup)\n- [Credits](#credits)\n\n\n\n## Features\n- Look up official rule documentation, falling back to a web search if the\n source does not have rule documentation.\n- Add inline-comments to ignore rules like `// eslint disable-next-line\n some-rule`. Supports previous line, same line, and enclosing lines.\n- QoL: auto-select a rule if it is the only one in the current line; if the line\n has no diagnostic, search forward up to the next line that does.\n- Includes built-in support for various linters. Zero plugin configuration\n required if you only need to use built-in sources.\n- Customizing built-in sources or adding your own sources is easy. PRs to add\n more built-ins are welcome.\n\n## Supported Sources\nYou easily add a custom source via the [plugin configuration](#configuration).\nThough, please consider making a PR to add support for a source if it is\nmissing.\n\n[Rule Data for the supported linters](./lua/rulebook/data)\n\n\n\n### Rule Lookup\n- `LTeX`\n- `Lua Diagnostics.`\n- `Pyright`\n- `Ruff`\n- `biome`\n- `clang-tidy`\n- `eslint`\n- `markdownlint`\n- `pylint`\n- `selene`\n- `shellcheck`\n- `stylelint`\n- `yamllint`\n\n### Add Ignore Comment\n- [LTeX](https://valentjn.github.io/ltex/advanced-usage.html)\n- [Pyright](https://microsoft.github.io/pyright/#/comments)\n- [alex](https://github.com/get-alex/alex#control)\n- [biome](https://biomejs.dev/linter/#ignoring-code)\n- [clang-tidy](https://clang.llvm.org/extra/clang-tidy/#suppressing-undesired-diagnostics)\n- [codespell](https://github.com/codespell-project/codespell/issues/1212#issuecomment-1721152455)\n- [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker#excluding-lines)\n- [eslint](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1)\n- [pylint](https://pylint.readthedocs.io/en/latest/user_guide/messages/message_control.html)\n- [selene](https://kampfkarren.github.io/selene/usage/filtering.html#allowingdenying-lints-for-an-entire-file)\n- [shellcheck](https://www.shellcheck.net/wiki/Ignore)\n- [stylelint](https://stylelint.io/user-guide/ignore-code/)\n- [typescript](https://www.typescriptlang.org/)\n- [vale](https://vale.sh/docs/topics/config/#markup-based-configuration)\n- [woke](https://docs.getwoke.tech/ignore/#in-line-and-next-line-ignoring)\n- [yamllint](https://yamllint.readthedocs.io/en/stable/disable_with_comments.html)\n\n\n## Installation\nThis plugin requires diagnostics provided by a source that supports Neovim's\nbuilt-in diagnostics system. (nvim's built-in LSP client or\n[nvim-lint](https://github.com/mfussenegger/nvim-lint) are such sources.)\n\n```lua\n-- lazy.nvim\n{\n\t\"chrisgrieser/nvim-rulebook\",\n\tkeys = {\n\t\t{ \"i\", function() require(\"rulebook\").ignoreRule() end },\n\t\t{ \"l\", function() require(\"rulebook\").lookupRule() end },\n\t}\n},\n```\n\n```lua\n-- packer\nuse { \"chrisgrieser/nvim-rulebook\" }\n\n-- in your config\nvim.keymap.set(\"n\", \"i\", function() require(\"rulebook\").ignoreRule() end)\nvim.keymap.set(\"n\", \"l\", function() require(\"rulebook\").lookupRule() end)\n```\n\n## Configuration\nThe configuration is optional. You only need to add a config when you want to\ncustomize a source or add custom sources.\n\nWhen adding your own source, you must add the *exact*, case-sensitive\nsource-name. (for example, `clang-tidy`, not `clang`).\n\n```lua\nrequire(\"rulebook\").setup = ({\n\tignoreComments = {\n\t\tselene = {\n\t\t\tcomment = \"-- selene: allow(%s)\",\n\t\t\tlocation = \"prevLine\",\n\t\t},\n\t\t-- ... (full list of supported sources can be found in the README)\n\n\t\tyourCustomSource = { -- exact, case-sensitive source-name\n\t\t\tcomment = \"// disabling-comment %s\", -- %s will be replaced with rule-id\n\t\t\tlocation = \"prevLine\", -- \"prevLine\"|\"sameLine\"|\"encloseLine\"\n\t\t}\n\n\t\t-- if location is \"encloseLine\", needs to be a list of two strings\n\t\tanotherCustomSource = {\n\t\t\tcomment = { \"// disable-rule %s\", \"// enable-rule %s\" },\n\t\t\tlocation = \"encloseLine\",\n\t\t}\n\t},\n\n\truleDocs = {\n\t\tselene = \"https://kampfkarren.github.io/selene/lints/%s.html\"\n\t\t-- ... (full list of supported sources can be found in the README)\n\n\t\t-- Search URL when no documentation definition is available for a\n\t\t-- diagnostic source. `%s` will be replaced with the diagnostic source & code.\n\t\t-- Default is the DDG \"Ducky Search\" (automatically opening first result).\n\t\tfallback = \"https://duckduckgo.com/?q=%s+%%21ducky&kl=en-us\",\n\n\t\t-- the value of the rule documentations accept either a string or a function\n\t\t-- if a string, `%s` will be replaced with rule-id\n\t\t-- if a function, takes a `:h diagnostic-structure` as argument and must \n\t\t-- return a url\n\t\tyourCustomSource = \"https://my-docs/%s.hthml\",\n\t\tanotherCustomSource = function(diag)\n\t\t\t-- ...\n\t\t\treturn url\n\t\tend,\n\t}\n\n\t-- if no diagnostic is found in current line, search this many lines forward\n\tforwSearchLines = 10,\n})\n```\n\nThe plugin uses\n[vim.ui.select](https://neovim.io/doc/user/lua.html#vim.ui.select()), so the\nappearance of the rule selection can be customized by using a UI-plugin like\n[dressing.nvim](https://github.com/stevearc/dressing.nvim).\n\n## Customize Built-in Sources\nBuilt-in sources be customized by overwriting them in the configuration:\n\n```lua\n-- use `disable-line` instead of the default `disable-next-line` for eslint\nrequire(\"rulebook\").setup = {\n\tignoreComments = {\n\t\teslint = {\n\t\t\tcomment = \"// eslint-disable-line %s\",\n\t\t\tlocation = \"sameLine\",\n\t\t},\n\t},\n}\n```\n\n## Limitations\n- The diagnostics have to contain the necessary data, [that is a diagnostic code\n and diagnostic\n source](https://neovim.io/doc/user/diagnostic.html#diagnostic-structure). Most\n LSPs, and most linters configured for `nvim-lint` do that, but some diagnostic\n sources do not (for example `efm-langserver` with incorrectly defined\n `errorformat`). Please open an issue at the diagnostics provider to fix such\n issues.\n- This plugin does not hook into `vim.lsp.buf.code_action`, but provides its own\n selector.\n\n## API\n\n### Availability of Rule Lookup\nThe function `require(\"rulebook\").hasDocs(diag)`, expects a diagnostic object\nand returns a boolean whether `nvim-rulebook` documentation for the respective\ndiagnostic available. One use case for this is to add a visual indicator if\nthere is a rule lookup available for a diagnostic (see\n[vim.diagnostic.config](https://neovim.io/doc/user/diagnostic.html#vim.diagnostic.config())).\n\n```lua\nvim.diagnostic.config {\n\tvirtual_text = {\n\t\tsuffix = function(diag) return require(\"rulebook\").hasDocs(diag) and \"  \" or \"\" end,\n\t},\n}\n```\n\n## Credits\n\n**About Me** \nIn my day job, I am a sociologist studying the social mechanisms underlying the\ndigital economy. For my PhD project, I investigate the governance of the app\neconomy and how software ecosystems manage the tension between innovation and\ncompatibility. If you are interested in this subject, feel free to get in touch.\n\n**Blog** \nI also occasionally blog about vim: [Nano Tips for Vim](https://nanotipsforvim.prose.sh)\n\n**Profiles** \n- [reddit](https://www.reddit.com/user/pseudometapseudo)\n- [Discord](https://discordapp.com/users/462774483044794368/)\n- [Academic Website](https://chris-grieser.de/)\n- [Twitter](https://twitter.com/pseudo_meta)\n- [Mastodon](https://pkm.social/@pseudometa)\n- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)\n- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)\n\n\n","dotfyleShieldAddedAt":"2023-09-23T02:10:11.183Z","stars":50,"lastSyncedAt":"2023-11-28T02:21:12.364Z","addedLastWeek":0}}}]}}]