{"id":13412400,"url":"https://github.com/zbirenbaum/neodim","last_synced_at":"2025-04-06T02:08:38.864Z","repository":{"id":37477743,"uuid":"479307180","full_name":"zbirenbaum/neodim","owner":"zbirenbaum","description":"Neovim plugin for dimming the highlights of unused functions, variables, parameters, and more","archived":false,"fork":false,"pushed_at":"2024-07-28T11:36:50.000Z","size":89,"stargazers_count":306,"open_issues_count":3,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-12T22:51:59.559Z","etag":null,"topics":["lsp","lua","neovim"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zbirenbaum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-08T08:26:20.000Z","updated_at":"2024-10-11T07:46:17.000Z","dependencies_parsed_at":"2024-01-03T03:29:45.757Z","dependency_job_id":"d0e6946e-45ca-447c-99c2-f5c1e322150c","html_url":"https://github.com/zbirenbaum/neodim","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbirenbaum%2Fneodim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbirenbaum%2Fneodim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbirenbaum%2Fneodim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbirenbaum%2Fneodim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zbirenbaum","download_url":"https://codeload.github.com/zbirenbaum/neodim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423514,"owners_count":20936626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lsp","lua","neovim"],"created_at":"2024-07-30T20:01:24.250Z","updated_at":"2025-04-06T02:08:38.839Z","avatar_url":"https://github.com/zbirenbaum.png","language":"Lua","funding_links":[],"categories":["Utility","Lua","Editing Support"],"sub_categories":["Cursorline","Scrollbar"],"readme":"# neodim\n\n\u003e *Neovim plugin for dimming the highlights of unused functions, variables, parameters, and more*\n\nThis plugin takes heavy inspiration from https://github.com/NarutoXY/dim.lua. \\\nThe implementation in NarutoXY/dim.lua was a bit inefficient and I saw room for various improvements,\nincluding making the dimming an actual LSP handler, rather than an autocmd.\nThe result is a much more polished experience with greater efficiency.\n\n## Setup\n\n### Requirements\n\n- Neovim 0.10.0 or later\n- Language server that supports [diagnostic tags](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnosticTag)\n\n### Installation\n\nYou can install with builtin packages or your favorite package manager.\n\nThe following is an example installation using Lazy.nvim:\n\n```lua\n{\n  \"zbirenbaum/neodim\",\n  event = \"LspAttach\",\n  config = function()\n    require(\"neodim\").setup()\n  end,\n}\n```\n\n## Options\n\n```lua\nrequire(\"neodim\").setup({\n  alpha = 0.75,\n  blend_color = nil,\n  hide = {\n    underline = true,\n    virtual_text = true,\n    signs = true,\n  },\n  regex = {\n    \"[uU]nused\",\n    \"[nN]ever [rR]ead\",\n    \"[nN]ot [rR]ead\",\n  },\n  priority = 128,\n  disable = {},\n})\n```\n\n### Dim Highlight Options\n\n#### alpha\n\n`alpha` controls how dim the highlight becomes.\nA value of 1 means that dimming will do nothing at all, while a value of 0 will make it identical to the color set in `blend_color`.\nConceptually, if you were to place the text to be dimmed on a background of `blend_color`,\nand then set the opacity of the text to the value of alpha, you would have the resulting color that the plugin highlights with.\n\n\n```lua\nrequire(\"neodim\").setup({\n  alpha = 0.5 -- make the dimmed text even dimmer\n})\n```\n\n#### blend_color\n\n`blend_color` controls the color which is used to dim your highlight.\nneodim sets this option automatically, so you don't need to set it if you want to set to the background color of the `Normal` highlight.\n\nExample:\n\n```lua\nrequire(\"neodim\").setup({\n  blend_color = \"#10171f\"\n})\n```\n\n### regex\n\nIf the diagnostic message matches one of these, the code to which the diagnostic refers is dimmed.\n\nYou can set up each filetype by entering in a table with the key as the filetype.\n\nExample:\n```lua\n  require(\"neodim\").setup({\n    regex = {\n      \"[Uu]nused\",\n      cs = {\n        \"CS8019\",\n      },\n      -- disable `regex` option when filetype is \"rust\"\n      rust = {},\n    }\n  })\n```\n\n### Decoration Options\n\nAll decorations can be hidden for diagnostics pertaining to unused tokens. \\\nBy default, hiding all of them is enabled, but you can re-enable them by changing the config table passed to neodim.\n\nIt is important to note that regardless of what you put in this configuration,\nneodim will always respect settings created with `vim.diagnostic.config`.\nFor example, if all underline decorations are disabled by running `vim.diagnostic.config({ underline=false })`,\nneodim will ***not*** re-enable them for \"unused\" diagnostics.\n\nExample:\n\n```lua\n-- re-enable only sign decorations for 'unused' diagnostics\nrequire(\"neodim\").setup({\n  hide = { signs = false }\n})\n```\n\n```lua\n-- re-enable all decorations for 'unused' diagnostics\nrequire(\"neodim\").setup({\n  hide = {\n    virtual_text = false,\n    signs = false,\n    underline = false,\n  }\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbirenbaum%2Fneodim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzbirenbaum%2Fneodim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbirenbaum%2Fneodim/lists"}