Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javiorfo/nvim-fuel
Neovim plugin written in Lua for running a main or script in several languages
https://github.com/javiorfo/nvim-fuel
assembly cpp go haskell java kotlin lua main neovim neovim-plugin python rust scala scheme zig
Last synced: 2 months ago
JSON representation
Neovim plugin written in Lua for running a main or script in several languages
- Host: GitHub
- URL: https://github.com/javiorfo/nvim-fuel
- Owner: javiorfo
- License: other
- Created: 2023-02-02T02:20:37.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T13:09:53.000Z (5 months ago)
- Last Synced: 2024-09-08T14:33:00.992Z (5 months ago)
- Topics: assembly, cpp, go, haskell, java, kotlin, lua, main, neovim, neovim-plugin, python, rust, scala, scheme, zig
- Language: Lua
- Homepage:
- Size: 213 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-fuel
### Fuel for your programs
*nvim-fuel is a Neovim plugin for running a main or script in several languages. This is meant to be useful for practicing and maybe teaching.*
## Caveats
- To use this plugin in a particular language, **the compiler or language itself needs to be installed**.
- Supported languages are: **Assembly, C, C++, Clojure, Go, Haskell, Java, Kotlin, Lua, Python, Rust, Scala, Scheme and Zig**
- Posibility to add custom language implementations
- This plugin has been developed on and for Linux following open source philosophies.
## Overview
| Feature | nvim-fuel | NOTE |
| ------- | ------------- | ---- |
| Command to show results in Fuel Console | :heavy_check_mark: | Set by `Fuel` |
| Command to close Fuel Console | :heavy_check_mark: | Set by `FuelStop` |
| Execution in Normal Mode | :heavy_check_mark: | Set by `Fuel` |
| Execution in Insert Mode | :heavy_check_mark: | Set by `Fuel` |
| Console size configurable | :heavy_check_mark: | By `setup` |
| Autosave configurable | :heavy_check_mark: | By `setup` |
| Supports different languages in same window (different buffers) | :heavy_check_mark: | |
| Supports custom language implementations | :heavy_check_mark: | |
| Main arguments | :x: | |
| Stdin | :heavy_check_mark: | |
| Popup console | :heavy_check_mark: | By `setup` |
## Installation
`Packer`
```lua
use {
'javiorfo/nvim-fuel',
requires = 'javiorfo/nvim-popcorn'
}
```
`Lazy`
```lua
{
'javiorfo/nvim-fuel',
lazy = true,
dependencies = { 'javiorfo/nvim-popcorn' },
-- ft could contain only the languages nvim-fuel will be used for
ft = { "asm", "c", "cpp", "clojure", "go", "haskell", "java", "kotlin", "lua", "python", "rust", "scala", "scheme", "zig" },
opts = {
-- Not necessary. Only if you want to change the setup
view = {
-- Default console size (this applies to popup size too)
console_size = 10,
-- Default autosave before pressing the Fuel shortcut
autosave = true,
-- Default false. If you want to show the console in a popup instead of a buffer
popup = false
}
},
keys = {
{ "fu", "Fuel" },
{ "fs", "FuelStop" }
}
}
```
### Configuration (Packer)
- Set mappings in *init.vim* or *init.lua*
```lua
local opts = { noremap = true, silent = true }
-- Normal mode
vim.api.nvim_set_keymap('n', 'fu', 'Fuel', opts)
vim.api.nvim_set_keymap('n', 'fs', 'FuelStop', opts)
```
- Only the installation step is required to use this plugin, but you can modify this options if you like:
```lua
require'fuel'.setup{
view = {
-- Default console size (this applies to popup size too)
console_size = 10,
-- Default autosave before pressing the Fuel shortcut
autosave = true,
-- Default false. If you want to show the console in a popup instead of a buffer
popup = false
},
-- Override language implementations or implement a missing language
language_implementations = {
-- C example
c = {
-- Required build function
-- file_with_extension is this case will be 'file_name.c'
-- file is this case will be 'file_name'
build = function (file_with_extension, file)
vim.cmd("autocmd BufDelete c_fuel_main_console silent !rm -f " .. file)
return string.format("gcc -Wall %s -o /tmp/%s && /tmp/%s && rm -f /tmp/%s 2> /dev/null", file_with_extension, file, file, file)
end,
-- Required statusline function
-- This will print on cmd statusline after build is executed
get_statusline = function(file)
return util.statusline_style(" C", file)
end,
-- Required get_footer function
-- This will print on footer popup after build is executed
get_footer = function(file)
return util.footer(" C", file)
end
}
}
}
```
# Usage
- Executing the map corresponding to `Fuel` in a main or scripting file, it will compile and execute the aforementioned file opening a console ouput.
- Execute the map corresponding to `FuelStop` to close all open Fuel console. In case you are using `popup = true` just press
- To see the execution string use the command `:FuelInfo` which will open a popup with info
## Screenshots
### Java:
### C:
### Haskell and Rust in the same window:
### Kotlin:
#### With popup console
**NOTE:** The colorscheme **nebula** from [nvim-nyctophilia](https://github.com/javiorfo/nvim-nyctophilia) is used in this image.
---
### Donate
- **Bitcoin** [(QR)](https://raw.githubusercontent.com/javiorfo/img/master/crypto/bitcoin.png) `1GqdJ63RDPE4eJKujHi166FAyigvHu5R7v`
- [Paypal](https://www.paypal.com/donate/?hosted_button_id=FA7SGLSCT2H8G)