Skip to content

ej-shafran/compile-mode.nvim

Introduction

compile-mode.nvim is a Neovim plugin which emulates the features of Emacs' Compilation Mode. It allows you to run commands which are output into a special buffer, and then rerun that command over and over again as much as you need.

Features

out.mp4

Installation

Use your favorite plugin manager. compile-mode.nvim depends on plenary.nvim.

Warning

compile-mode.nvim only supports Neovim versions v0.10.0 and higher, and isn't expected to work for earlier versions.

Here's an example of a Lazy config for compile-mode.nvim:

return {
  "ej-shafran/compile-mode.nvim",
  tag = "v5.*",
  -- you can just use the latest version:
  -- branch = "latest",
  -- or the most up-to-date updates:
  -- branch = "nightly",
  dependencies = {
    "nvim-lua/plenary.nvim",
    -- if you want to enable coloring of ANSI escape codes in
    -- compilation output, add:
    -- { "m00qek/baleia.nvim", tag = "v1.3.0" },
  },
  config = function()
    ---@type CompileModeOpts
    vim.g.compile_mode = {
        -- to add ANSI escape code support, add:
        -- baleia_setup = true,
    }
  end
}

Contributing

Contributions are welcome in the form of GitHub issues and pull requests.

For contributing details see CONTRIBUTING.md.