vim-mix-format
Vim plugin for asynchronous Elixir code formatting using mix format.
What is vim-mix-format?
vim-mix-format is a Vim plugin that integrates Elixir's mix format command directly into Vim 8 and Neovim. It allows developers to format Elixir code asynchronously from within their editor, ensuring code consistency without interrupting workflow. The plugin supports features like automatic formatting on save and a diff preview for reviewing changes.
Elixir developers who use Vim or Neovim as their primary editor and want seamless, non-blocking code formatting integrated into their development environment.
Developers choose vim-mix-format for its lightweight, asynchronous integration of Elixir's official formatter, offering customization options and diff previews without the overhead of external tools or manual formatting processes.
Overview
Vim integration for the Elixir formatter.
Use Cases
Best For
- Formatting Elixir code automatically on save in Vim/Neovim
- Reviewing formatting changes with a diff preview before applying
- Integrating Elixir's mix format into a Vim-based workflow
- Using asynchronous formatting to avoid editor blocking
- Customizing formatter options for specific Elixir projects
- Working with multiple Elixir versions in different projects
Not Ideal For
- Developers using editors other than Vim 8 or Neovim, such as VSCode or IntelliJ with built-in Elixir support
- Teams that enforce formatting solely through CI/CD pipelines or pre-commit hooks without editor integration
- Projects not written in Elixir or using Elixir versions below 1.6 without an accessible alternative installation
- Users who prefer graphical diff tools or find Vim's diff mode challenging for reviewing changes
Pros & Cons
Pros
Runs mix format in the background without blocking the editor, allowing continuous work as demonstrated in the demo GIF, improving workflow efficiency.
Can be configured with `let g:mix_format_on_save = 1` to format files automatically on save, ensuring consistent code style with minimal effort.
Provides `:MixFormatDiff` to open a diff window for previewing changes, with commands like `dp` to apply selectively, enhancing user control over formatting.
Supports custom formatter options via `g:mix_format_options` and error handling with `g:mix_format_silent_errors`, allowing tailored integration for different projects.
Cons
Limited to Vim 8 and Neovim, excluding users of other editors or older Vim versions, which restricts its applicability in diverse development environments.
Requires Elixir 1.6+; for older versions, users must manually specify an alternative path with `g:mix_format_elixir_bin_path`, adding setup complexity.
The diff preview relies on Vim's native diff mode, which may be unfamiliar to some users, as hinted by the README linking to external resources for guidance.
Frequently Asked Questions
Related Projects
JetbrainsElixir plugin for JetBrain's IntelliJ Platform (including Rubymine)
vim-elixirVim configuration files for Elixir
AlchemistElixir Tooling Integration Into Emacs
elixir-lsA 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.
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.