How to set up mix format with vim-elixir?

vim-elixir doesn't include mix format integration by default. You can use external plugins like vim-mix-format or manually set formatprg in your vimrc. The README explains this omission due to compilation and dependency issues.

Is vim-elixir better than using an LSP for Elixir in Vim?

vim-elixir provides basic syntax and indentation, while an LSP (like elixir-ls) offers advanced features such as code completion and diagnostics. For minimal editing, vim-elixir suffices, but for full IDE capabilities, you'll need additional tooling.

Does vim-elixir work with Neovim?

Yes, vim-elixir is compatible with Neovim through standard plugin installation methods. The README includes configuration notes that apply to both Vim and Neovim, though some settings may vary.

What are the alternatives to vim-elixir for Elixir development?

Alternatives include using general LSP plugins (e.g., coc.nvim with elixir-ls) or other Elixir-specific tools. vim-elixir is unique for its lightweight, dependency-free approach focused on core editing features.

How can I debug indentation issues in vim-elixir?

The README provides a debugging guide using the bin/vim script to open files and check messages for indentation handler outputs. This helps identify which rules are triggered for troubleshooting.

Does vim-elixir support Surface framework files?

Yes, vim-elixir includes syntax highlighting for .sface files used by the Surface templating framework, as listed in the filetype detection and key features sections.

Open-Awesome

vim-elixir

NOASSERTIONRuby

Vim plugin providing syntax highlighting, filetype detection, and indentation for Elixir and EEx files.

Visit Website GitHub

1.3k stars154 forks0 contributors

What is vim-elixir?

vim-elixir is a Vim plugin that adds language support for Elixir, including syntax highlighting, filetype detection, and automatic indentation. It solves the problem of editing Elixir code efficiently in Vim by providing essential editor features tailored to the language's syntax and file types.

Target Audience

Elixir developers who use Vim or Neovim as their primary code editor and want native language support without switching to a different IDE.

Value Proposition

Developers choose vim-elixir for its lightweight, focused approach to Elixir editing—it delivers reliable core features without bloat, integrates well with existing Vim workflows, and is maintained by the Elixir community.

Overview

Vim configuration files for Elixir

Use Cases

Best For

Editing Elixir .ex and .exs files in Vim with proper syntax highlighting
Working with Phoenix templates like .eex, .heex, and .leex files
Automatically indenting Elixir code according to language conventions
Integrating Ecto projects with vim-dadbod for database query execution
Setting up a minimal Elixir development environment in Vim/Neovim
Maintaining consistent editing experience across Elixir file types

Not Ideal For

Developers who need built-in, automatic code formatting with mix format
Users requiring advanced IDE features like live view support or integrated debugging tools
Teams prioritizing plugins with active, frequent updates and a large ecosystem of integrations

Pros & Cons

Pros

Comprehensive File Support

Supports syntax highlighting and filetype detection for all major Elixir file types including .ex, .exs, .eex, .heex, .leex, and .sface, as detailed in the README's features list.

Lightweight and Stable

Focuses on core editing features without unnecessary dependencies, prioritizing stability and performance, which aligns with the project's philosophy stated in the description.

Ecto Database Integration

Integrates with vim-dadbod to run SQL queries on Ecto repositories directly from Vim, enhancing workflow for database interactions, as specified in the README.

Cons

Missing Formatting Integration

Deliberately excludes mix format support due to compilation issues and external process dependencies, requiring manual setup with plugins like vim-mix-format, as admitted in the Notes/Caveats section.

Maintenance Uncertainty

Actively seeking new maintainers, which could slow bug fixes and updates, as highlighted in the Development section under 'Maintenance Help'.

Indentation Edge Cases

Known issues with indentation rules for constructs like 'with' statements, requiring workarounds, as mentioned in the feature wishlist for fixes.

Frequently Asked Questions

Related Projects

Jetbrains

Elixir plugin for JetBrain's IntelliJ Platform (including Rubymine)

Stars1,899

Forks163

Last commit2 days ago

Alchemist

Elixir Tooling Integration Into Emacs

Stars913

Forks102

Last commit4 years ago

elixir-ls

A frontend-independent IDE "smartness" server for Elixir. Implements the JSON-based "Language Server Protocol" standard and provides debugger support via VS Code's debugger protocol.

Stars845

Forks49

Last commit6 years ago

Alchemist.vim

Elixir Integration Into Vim

Stars645

Forks38

Last commit3 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub