parinfer-rust
Infer parentheses for Clojure, Lisp and Scheme.
A full-featured, super fast implementation of Shaun Lebron’s parinfer. This repo has Vim, Neovim, and Kakoune plugins, and an Emacs plugin is available. The Rust library can be called from other editors that can load dynamic libraries.
This plugin, unlike others available for Vim, implements "smart" mode. Rather than switching between "paren" mode and "indent" mode, parinfer uses information about how the user is changing the file to decide what to do.
Installing
Dependencies:
-
rust >= 1.36
-
clangandlibclang-devpackages or equivalent for your OS
Stand-alone CLI
If you just want to run parinfer-rust from the command-line:
$ cargo build --release $ cargo install
If you use emacs add the corresponding feature flag during compilation
$ cargo build --release --features emacs
Vim and Neovim
pathogen
If you are using Tim Pope’s pathogen:
$ cd ~/.vim/bundle $ git clone [email protected]:eraserhd/parinfer-rust.git $ cd ~/.vim/bundle/parinfer-rust $ cargo build --release
vim-plug
Plug 'eraserhd/parinfer-rust'
Then, build project using cargo:
$ cd /path/to/parinfer-rust $ cargo build --release
Or, with optional automatic recompilation on update:
Plug 'eraserhd/parinfer-rust', {'do':
\ 'cargo build --release'}
If you are a NixOS user, you can use this command instead:
Plug 'eraserhd/parinfer-rust', {'do':
\ 'nix-shell --run \"cargo build --release \"'}
Kakoune
plug.kak
Add this to your kakrc
plug "eraserhd/parinfer-rust" do %{
cargo install --force --path .
} config %{
hook global WinSetOption filetype=(clojure|lisp|scheme|racket) %{
parinfer-enable-window -smart
}
}
Re-source your kakrc or restart Kakoune. Then run :plug-install. plug.kak will download, build and install plugin for you. Optionally add cargo clean line to the do block to clean plugin from build files, thus making it load a bit faster.
Manual
$ cd ~/my-projects $ git clone [email protected]:eraserhd/parinfer-rust.git $ cd parinfer-rust $ make install $ cargo build --release $ cargo install
Add this to your kakrc
hook global WinSetOption filetype=(clojure|lisp|scheme|racket) %{
parinfer-enable-window -smart
}
NixOS or nix-darwin
{
environment.systemPackages = let
myKakoune = pkgs.wrapKakoune pkgs.kakoune-unwrapped {
configure = {
plugins = with self.kakounePlugins; [
parinfer-rust
];
};
};
in [ myKakoune ];
}
Alternately, you can add your plugins as an overlay:
{
nixpkgs.overlays = [
(self: super: {
kakoune = super.wrapKakoune self.kakoune-unwrapped {
configure = {
plugins = with self.kakounePlugins; [
parinfer-rust
];
};
};
})
];
environment.systemPackages = [ pkgs.kakoune ];
}
Emacs
To install parinfer-rust for Emacs follow the instructions at parinfer-rust-mode.el
Building WebAssembly
WebAssembly currently needs the ``nigthly'' toolchain:
$ rustup update $ rustup install nightly $ rustup target add wasm32-unknown-unknown --toolchain nightly $ cargo +nightly install cargo-web
It can then be built with:
$ cargo +nightly web build --release
Tests
The CI server uses [Nix](https://nixos.org/nix/download.html) to make reproducible build and test environments. It’s a good idea to run tests with it.
$ nix-build release.nix # Build and test everything $ cargo test # Run the native tests $ cargo +nightly web test # Test the WebAssembly version $ vim --clean -u tests/vim/run.vim # Test against locally-installed Vim $ ( cd tests/kakoune && ./run.sh ) # Test against locally-installed Kakoune $ nix-build release.nix -A vim-tests # Test against Nix Vim package $ nix-build release.nix -A neovim-tests # Test against Nix Neovim package $ nix-build release.nix -A kakoune-tests # Test against Nix Kakoune package
Vim tests are in a nice, readable format in tests/vim/test-cases.md. Please add tests for any new features (or even old ones!). You can set the VIM_TO_TEST environment variable to Vim’s path to test weird or different builds.
Contributors
This wouldn’t be possible without the work of others:
-
Shaun Lebron - Inventing parinfer and doing the math.
-
Case Nelson - Writing the nvim-parinfer, from which VimL code and some inspiration was stolen.
-
Justin Barclay - Emacs module.
-
Michael Camilleri - User-defined comments.
-
Mitsuhiro Nakamura - Support for Common Lisp and Scheme.
-
ElKowar - User-defined string-delimiters and support for Yuck.
![[Kakoune] Doesn't work with tabs](https://avatars.githubusercontent.com/u/12158785?v=4)
143 Nov 5, 2021
35 Nov 21, 2022
4 Feb 26, 2023
9 Mar 25, 2023
80 Oct 10, 2023
57 Dec 7, 2022
19 Apr 13, 2022
3 Dec 3, 2022
28 Dec 7, 2022
10 Oct 5, 2022
42 Dec 17, 2023
14 Jan 7, 2023
255 Dec 30, 2022
2k Jan 3, 2023
54 Dec 23, 2022
598 Jan 2, 2023
314 Dec 18, 2022
793 Jan 2, 2023
3k Jan 8, 2023