Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 2.87 KB

README.md

File metadata and controls

69 lines (57 loc) · 2.87 KB
Raw

run.nvim

A minimalistic code runner for fast iteration.

Instead of having to configure per-project or per-extension run commands, run.nvim simply caches the last command you ran in the project, and uses that until you override it.

Setup / Configuration

Install the plugin with your favorite plugin manager, and call the setup function in your configuration (the values below are the defaults):

require("run").setup({
    -- Automatically save the current buffer before running the command.
    auto_save = false,
    -- The format used for sending a notification before running a command,
    -- where %s represents the command (see lua's string.format). Set to nil
    -- to disable notifications. Eg. "$ %s"
    notification_format = nil,
    -- Disable number and relativenumber.
    disable_number = true,
    -- The percentage to darken the window by, eg. 0.2 makes the terminal 20%
    -- darker, whereas -0.2 makes it 20% lighter. Set to false to disable.
    darken = 0.2,
    -- This is passed directly to `nvim_open_win` (see `:help nvim_open_win`),
    -- with the exception of row, column, width and height, which are used as
    -- percentages if between 0 and 1. Eg. 0.25 takes up 25% of Neovim's.
    -- width/height.
    winopts = {
        split = "below",
        height = 0.25
    },
    -- Automatically scroll the terminal as the running program outputs text
    auto_scroll = true
})

Usage

The plugin consists of only two commands: Run (lua: run.run(command, override)) and RunPrompt (lua: run.run_prompt()). Here is how they work:

  1. Run
    • If an argument was passed, use that as the command without overriding the cached one
    • If an argument was not passed, use the command from the cache, or prompt for one
  2. Run!
    • If an argument was passed, use that as the command, and override the cached one with it
    • If an argument was not passed, prompt for one, and override the cached command with it
  3. RunPrompt
    • Prompt for a command and run it without updating the cache

It's also recommended to create mappings:

local run = require("run")

-- Runs the cached command
vim.keymap.set('n', "<leader>ri", run.run)
-- Prompts for a command, and overrides the cached one with it
vim.keymap.set('n', "<leader>ro", function() run.run(nil, true) end)
-- Prompts for a command to run, without overriding
vim.keymap.set('n', "<leader>rc", run.run_prompt)

API

The plugin exposes the following fields:

  • setup() - initialization
  • run(command, override) - equivalent of the Run command (the bang means passing true as the second argument), see Usage
  • run_prompt() - equivalent of the RunPrompt command, see Usage
  • cache - this is simply a table mapping paths to commands. Note that setting a field in the table will overwrite it in the cache on the disk as well.
  • config - the configuration table in use