Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brendalf/mix.nvim
A Mix Wrapper for Neovim
https://github.com/brendalf/mix.nvim
Last synced: about 1 month ago
JSON representation
A Mix Wrapper for Neovim
- Host: GitHub
- URL: https://github.com/brendalf/mix.nvim
- Owner: brendalf
- Created: 2022-01-25T14:55:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T12:06:10.000Z (almost 2 years ago)
- Last Synced: 2024-01-31T08:02:42.639Z (4 months ago)
- Language: Lua
- Homepage:
- Size: 43.9 KB
- Stars: 25
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-elixir - mix.nvim - Mix wrapper plugin for Neovim. (Editors)
- awesome-neovim - brendalf/mix.nvim - Mix (from Elixir) wrapper plugin. (Programming Languages Support / (requires Neovim 0.5))
- awesome-neovim - brendalf/mix.nvim - Mix (from Elixir) wrapper plugin. (Programming Languages Support / (requires Neovim 0.5))
- awesome-neovim - brendalf/mix.nvim - Mix (from Elixir) wrapper plugin. (Programming Languages Support / (requires Neovim 0.5))
- fucking-awesome-elixir - mix.nvim - Mix wrapper plugin for Neovim. (Editors)
README
# mix.nvim
A Mix (Elixir) wrapper for Neovim.
This plugin adds a `:Mix` (or just `:M`), which calls any arbitrary Mix command.
If you know how to use Mix at the command line, you know how to use `:Mix`.
It's vaguely akin to `:!mix` but with some improvements:
* Autocompletion for available Mix commands inside the current repository.
* Choose the type of window you want to show the output (WiP).
* Support Telescope integration to navigate through package's documentation (WiP).
* Run async commands inside Neovim (WiP).
## Getting Started
This section should guide you to run your first Mix command with `:Mix`.
[Neovim 0.7](https://github.com/neovim/neovim/releases/tag/v0.7.0) or higher is required for `mix.nvim` to work.
### Recommended dependencies
* [hrsh7th/cmp-cmdline](https://github.com/hrsh7th/cmp-cmdline) to enable smooth auto completion.
### Installation
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use { 'brendalf/mix.nvim', requires = { "nvim-lua/plenary.nvim" } }
```
Using [vim-plug](https://github.com/junegunn/vim-plug)
```viml
Plug 'nvim-lua/plenary.nvim'
Plug 'brendalf/mix.nvim'
```
Using [dein](https://github.com/Shougo/dein.vim)
```viml
call dein#add('nvim-lua/plenary.nvim')
call dein#add('brendalf/mix.nvim')
```
After installing, you need to initialize `mix.nvim` with the setup function.
For example:
```lua
require("mix").setup()
```
## Usage
The basic usage is `:Mix `.
Type `:Mix help` to see if `mix.nvim` is installed correctly.
If you have [hrsh7th/cmp-cmdline](https://github.com/hrsh7th/cmp-cmdline) installed:
* Type `:Mix` and press `space` to see the available Mix commands (this could take a couple seconds in the first run).
* With the commands loaded you can start typing to get a smooth auto complete experience.
If you are using neovim (or lunarvim) without any cmd plugin:
* Type `:Mix`, press `space`, and then press `tab` to see the available Mix commands.
* Use `tab` to cycle through the commands or type the whole command wording.
As mentioned above, loading the list of commands in the first time can take some time, because `mix.nvim` is actually reading them from the output of `mix help`.
To enable a smooth experience, we save the list of commands internally after the initial loading.
To update the cache, you can call `:MixRefreshCompletions`.
## Contributing
All contributions are welcome! Just open a pull request.
Please look at the [Issues](https://github.com/brendalf/mix.nvim/issues) page to see the current backlog, suggestions, and bugs to work.
## License
Distributed under the same terms as Neovim itself.