How to set up code_runner.nvim for Python with arguments?

Define a function in the filetype config using vim.ui.input to prompt for arguments, e.g., for Python, set 'python = function() ... end' to run 'python3 -u $file' with inputs. This allows interactive testing without leaving Neovim.

Can code_runner.nvim run Java projects with Maven or Gradle?

Yes, configure project-specific commands in Lua or JSON, such as 'command = "mvn compile exec:java"' for Maven. Use the project management feature to define patterns matching your project root.

code_runner.nvim vs vim-test: which is better for testing?

code_runner.nvim is general-purpose for code execution and project runs, while vim-test is specialized for running test suites. Choose vim-test if you focus on testing frameworks, or code_runner.nvim for broader execution needs.

How to enable hot reload with code_runner.nvim?

Use custom hooks with Lua functions, like in the README's markdown example, to compile on save. The experimental hot_reload option is available but less recommended than creating autocommands for stability.

Does code_runner.nvim work with toggleterm?

Yes, set mode = 'toggleterm' in setup, and it integrates with toggleterm.nvim for terminal-based execution. Ensure toggleterm is installed and configured separately for smooth operation.

What are the variables like $dir and $fileName in commands?

These are placeholders replaced at runtime: $dir is the file's directory, $fileName is the full filename. They mirror VS Code Code Runner's format for compatibility and ease of migration.

Open-Awesome

code_runner.nvim

MITLua

A blazing-fast Neovim plugin written in pure Lua that runs code in multiple modes and manages project-specific commands.

GitHub

688 stars38 forks0 contributors

What is code_runner.nvim?

Code Runner is a Neovim plugin that allows developers to execute code directly within the editor across multiple programming languages. It solves the problem of switching between terminals or IDEs by providing a fast, configurable runner with project-aware commands. The plugin supports various display modes and is compatible with VS Code's configuration format.

Target Audience

Neovim users who frequently run code snippets or projects and want a fast, integrated execution environment without leaving the editor. It's ideal for developers working with multiple languages or complex project setups.

Value Proposition

Developers choose Code Runner for its blazing-fast performance, extensive customization options, and seamless integration with Neovim. Unlike heavier IDE runners, it remains lightweight while offering advanced features like project management, interactive arguments, and custom hooks.

Overview

Neovim plugin.The best code runner you could have, it is like the one in vscode but with super powers, it manages projects like in intellij but without being slow

Use Cases

Best For

Running code snippets in multiple programming languages without leaving Neovim
Managing project-specific build and run commands in a lightweight editor
Executing code in floating windows or split terminals for better workflow
Migrating from VS Code Code Runner to a faster Neovim-based solution
Adding interactive command-line argument prompts for compiled languages
Creating custom execution hooks for complex workflows like PDF previews

Not Ideal For

Teams relying on graphical debuggers or integrated testing suites with breakpoints
Users wanting zero-configuration runners with pre-set templates for all languages
Developers working primarily in editors other than Neovim or preferring GUI-based IDEs

Pros & Cons

Pros

Blazing Fast Execution

Written in pure Lua, it runs code directly in Neovim without the overhead of external IDEs or Electron bloat, ensuring minimal latency.

Flexible Display Modes

Supports floating windows, tabs, splits, toggle terminals, and tmux panes, allowing users to tailor output viewing to their workflow.

VS Code Config Compatibility

Uses the same JSON configuration format as the VS Code Code Runner extension, easing migration and reducing setup time for former VS Code users.

Project-Aware Command Management

Allows defining project-specific run commands with patterns, similar to IDE features, without adding performance overhead.

Cons

Dependency on External Plugins

Key modes like toggle runner require installing betterTerm.nvim, and tmux pane support needs vimux, adding setup complexity and potential compatibility issues.

Manual Configuration Overhead

Users must write shell commands for each filetype and project in Lua or JSON, which can be error-prone and time-consuming compared to plug-and-play solutions.

Limited Out-of-the-Box Support

Does not include pre-configured commands for all languages; users need to set up runners from scratch, which may deter beginners or those needing quick starts.

Open Source Alternative To

code_runner.nvim is an open-source alternative to the following products:

VS Code Code Runner

Code Runner is a Visual Studio Code extension that allows users to run code snippets or files in multiple programming languages directly within the editor.

Frequently Asked Questions

Related Projects

overseer.nvim

A task runner and job management plugin for Neovim

Stars1,894

Forks101

Last commit27 days ago

sniprun

A neovim plugin to run lines/blocs of code (independently of the rest of the file), supporting multiples languages

Stars1,707

Forks52

Last commit2 months ago

iron.nvim

Interactive Repl Over Neovim

Stars1,349

Forks109

Last commit4 months ago

molten-nvim

A neovim plugin for interactively running code with the jupyter kernel. Fork of magma-nvim with improvements in image rendering, performance, and more

Stars1,195

Forks65

Last commit3 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub