https://github.com/ojroques/nvim-buildme
A Neovim plugin to run a script using the built-in terminal
https://github.com/ojroques/nvim-buildme
Last synced: 2 months ago
JSON representation
A Neovim plugin to run a script using the built-in terminal
- Host: GitHub
- URL: https://github.com/ojroques/nvim-buildme
- Owner: ojroques
- License: bsd-2-clause
- Created: 2021-01-17T18:22:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T07:35:59.000Z (12 months ago)
- Last Synced: 2024-10-12T22:34:13.462Z (8 months ago)
- Language: Lua
- Homepage:
- Size: 350 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-buildme
A Neovim plugin to run a script using the built-in terminal. You can use this
script to build a project, run tests, start containers...
## Usage
The plugin checks for a Buildme script and runs it in a terminal buffer. By
default, this is a shell script named `.buildme.sh` located in the current
working directory.
To run a Buildme job:
```lua
require('buildme').run()
```
To pass arguments to the Buildme script:
```lua
require('buildme').run({'arg1', 'arg2'})
```
To stop a running Buildme job:
```lua
require('buildme').stop()
```
To edit the Buildme script:
```lua
require('buildme').edit()
```
To jump to the Buildme buffer:
```lua
require('buildme').jump()
```
## Configuration
Here are all available options with their default settings:
```lua
require('buildme').setup {
script = '.buildme.sh', -- the Buildme script to execute
interpreter = 'bash', -- the interpreter to use (bash, python, ...)
wincmd = '', -- a command to run prior to a Buildme job (split, vsplit, ...)
}
```