{"id":13473436,"url":"https://github.com/elixir-lsp/coc-elixir","last_synced_at":"2025-04-03T03:10:33.282Z","repository":{"id":40653724,"uuid":"194131939","full_name":"elixir-lsp/coc-elixir","owner":"elixir-lsp","description":"Elixir language server extension based on elixir-ls for coc.nvim","archived":false,"fork":false,"pushed_at":"2024-06-15T09:23:32.000Z","size":730,"stargazers_count":168,"open_issues_count":19,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T14:22:25.000Z","etag":null,"topics":["coc","elixir","lsp","neovim","vim"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elixir-lsp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-06-27T16:49:06.000Z","updated_at":"2024-08-19T04:32:08.000Z","dependencies_parsed_at":"2023-02-01T17:16:12.213Z","dependency_job_id":"d3343b65-cdf7-4277-b907-708abd914d4c","html_url":"https://github.com/elixir-lsp/coc-elixir","commit_stats":{"total_commits":78,"total_committers":14,"mean_commits":5.571428571428571,"dds":"0.21794871794871795","last_synced_commit":"a48b9c8fd8651fc3886b16f5c2fc367d91f4cffc"},"previous_names":["amiralies/coc-elixir"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-lsp%2Fcoc-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-lsp%2Fcoc-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-lsp%2Fcoc-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-lsp%2Fcoc-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elixir-lsp","download_url":"https://codeload.github.com/elixir-lsp/coc-elixir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246424150,"owners_count":20774911,"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":["coc","elixir","lsp","neovim","vim"],"created_at":"2024-07-31T16:01:03.634Z","updated_at":"2025-04-03T03:10:33.260Z","avatar_url":"https://github.com/elixir-lsp.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Language Support"],"sub_categories":[],"readme":"# coc-elixir\n\nElixir language server extension based on [elixir-ls](https://github.com/elixir-lsp/elixir-ls) for [`coc.nvim`](https://github.com/neoclide/coc.nvim).\n\n## Install\n\n### CocInstall\n\n1. Make sure you've got `elixir` and `mix` available in `$PATH`.\n\n2. Inside (neo)vim run this command:\n\n```\n:CocInstall coc-elixir\n```\n\n### vim-plug\n\n1. Make sure you've got `elixir`, `mix` and `yarn` available in `$PATH`.\n\n2. Inside your `plug#begin/end` block in your `.vimrc` (vim) or `init.vim` (neovim) file, after `coc.nvim` add:\n\n```\nPlug 'elixir-lsp/coc-elixir', {'do': 'yarn install \u0026\u0026 yarn prepack'}\n```\n3. Get the latest elixir-ls release from [here](https://github.com/elixir-lsp/elixir-ls/releases/tag/v0.7.0) and unzip it into `~/.vim/plugged/coc-elixir/els-release` (`unzip elixir-ls.zip -d ~/.vim/plugged/coc-elixir/els-release`).\n\n## Features\n- Go to definition support\n- Code completion\n- Inline diagnostic (Build errors and warning)\n- Documentation on hover\n- Smart closing of code blocks\n- Code formatter\n\n## Dialyzer integration\nCoc-elixir will automatically analyze your project with [Dialyzer](http://erlang.org/doc/apps/dialyzer/dialyzer_chapter.html) after each successful build. It maintains a \"manifest\" file in `.elixir_ls/dialyzer_manifest` that stores the results of the analysis.\n\nYou can control which warnings are shown using the `elixirLS.dialyzerWarnOpts` setting in `coc-setting.json`, found at `~/.config/nvim/coc-settings.json`, or use command `:CocConfig` to open configuration file.\nYou can find available options in Erlang [docs](http://erlang.org/doc/man/dialyzer.html) at section \"Warning options\".\n\nTo disable Dialyzer completely add setting:\n```json\n{\n  \"elixirLS.dialyzerEnabled\": false\n}\n```\nYou can also set the module attribute @dialyzer to show or hide warnings at a module or function level.\n\n## Mix environment and target settings\n\nYou can control the settings that ElixirLS uses for Mix environment and target using either the user `coc-settings.json` or a [workspace configuration](https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file#configuration-file-resolve).\n\nTo change the Mix environment and target, add the settings:\n```json\n{\n  \"elixirLS.mixEnv\": \"dev\",\n  \"elixirLS.mixTarget\": \"test\"\n}\n```\n\n## Troubleshooting\n\n### Server fails to start\n\nUpon upgrading `coc-elixir` it is possible that the binary files were compiled\nusing an OTP or Elixir version that differ from the ones you have installed.\nWhen this happens, the language server will fail to start.\n\nYou can build [ElixirLS](https://github.com/elixir-lsp/elixir-ls) yourself to\nsolve this:\n\nStart by building a binary of ElixirLS from its source:\n\n```\ngit clone https://github.com/elixir-lsp/elixir-ls.git ~/.elixir-ls\ncd ~/.elixir-ls\nmix deps.get \u0026\u0026 mix compile \u0026\u0026 mix elixir_ls.release -o release\n```\n\nAfterwards, create or update your coc-settings file and add this line:\n\n```json\n{\n  \"elixir.pathToElixirLS\": \"~/.elixir-ls/release/language_server.sh\"\n}\n```\n\nTo open your coc-settings file directly from Vim or Nvim, you can use this command:\n\n```\n:CocConfig\n```\n\nDoing these steps should make this plugin work with [CoC](https://github.com/neoclide/coc.nvim).\n\n### coc-elixir is installed correctly but doesn't work\n\nMake sure `filetype` is set to `elixir`, or install [vim-elixir](https://github.com/elixir-editors/vim-elixir) which sets up file extension associations and syntax highlighting.\n\n## License\n\nMIT\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felixir-lsp%2Fcoc-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felixir-lsp%2Fcoc-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felixir-lsp%2Fcoc-elixir/lists"}