https://github.com/rgolangh/venkat.nvim

nvim plugin to execute on save main source files
https://github.com/rgolangh/venkat.nvim

lua neovim nvim nvim-plugin

Last synced: 14 days ago
JSON representation

nvim plugin to execute on save main source files

• Host: GitHub
• URL: https://github.com/rgolangh/venkat.nvim
• Owner: rgolangh
• License: mit
• Created: 2024-03-23T17:55:35.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-04T12:17:33.000Z (4 months ago)
• Last Synced: 2024-11-07T10:53:14.990Z (2 months ago)
• Topics: lua, neovim, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 9.77 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# venkat.nvim

nvim plugin to execute on-save source files and prints back the result in a pop up window.

Release the window with .

This plugin is inspired by Venkat Subramanian usage of TextMate in his presentations

and by TJ with his excellent autocmd tutorial.

By default whenever saving a main.go, main.py, main.rs, main.java, nvim will compile and run, and preview 

the result in a floating window.

## Installation

using packer:

```lua

    use('rgolangh/venkat.nvim')

```

using Lazy:

```lua

    return {

        { "rgolangh/venkat.nvim", lazy = false },

    }

```

Here's the default configuration:

```lua

languages = {

    go = { cmdline = "go run %s", pattern = "main.go" },

    java = { cmdline = "java %s", pattern = "Main.java" },

    python = { cmdline = "python %s", pattern = "main.py" },

    rust = { cmdline = "cargo %s", pattern = "main.rs" },

    zig = { cmdline = "zig run %s", pattern = "main.zig" },

}

```

The use of pattern here adheres to nvim's file pattern usage. 

Because executing all the file on save is not usually what you want while developing, a pattern can make this 

more handy. Consider these examples:

```lua

-- all python files under demos a relative demos directory:

    pattern = "*/demos/*.py"

-- all python files under demos a relative demos directory and any main.py:

    pattern = "demos/*.py,main.py"

```

For more info see `:help file-pattern`

If you want to customize the configuration, expand the config in `init.lua` or set this `$HOME/.config/nvim/after/plugin/venkat.lua` :

```lua

require('venkat').setup({

    languages = {

        go = { cmdline = "go run %s", pattern = "demos/*.go,main.go" },

        java = { cmdline = "java %s", pattern = "demos/*.java,Main.java" },

        python = { cmdline = "python %s", pattern = "demos/*.py,main.py" },

        rust = { cmdline = "cargo -Zscript %s", pattern = "main.rs" },

        zig = { cmdline = "zig run %s", pattern = "main.zig" },

        c = { cmdline = "zig run -lc %s", pattern = "main.c" },

}})

```