killthemule / nvimpam

Neovim RPC plugin for pamcrash files

nvimpam

The beginning of a neovim rpc plugin for pamcrash files. Right now, it does folding. Future dreams include syntax highlighting and status line hints.

Based on neovim-scorched-earth. Uses daa84/neovim-lib.

Installation

First and foremost, you will need the nvimpam binary. For that, get a rust installation (the stable release is sufficient), and run cargo install nvimpam (you will need to have the installation directory in your PATH). If requested, I'd provide prebuilt binaries as well, just let me know through a github issue.

To get the plugin files, either point your plugin manager to the github repository, or copy the following folders into your neovim config directory (see :h xdg): ftdetect, ftplugin, lua, doc.

Usage

See :h nvimpam for usage hints.

Contributing

I'd love contributions, comments, praise, criticism... You could open an issue or a pull request, or if you want a direct contact, meet me in the neovim gitter channel. I also read the subreddits for rust and neovim, if that suits you better.

Running tests

Running

cargo test

in the main folder will run the tests in the rust code and documentation. There will not be many of those, most of the testing will be done through neovim functional tests (written in lua). For those, run

TEST_FILE=../test/nvimpam_spec.lua make functionaltest

in the neovim folder of this repository. This might take some time on th first run because it needs to compile neovim and its dependencies.

License

Dual-Licensed under Apache or MIT at your leisure, see the LICENSE-* files.

CoC

Wherever applicable, this project follows the rust code of conduct.