susensio / shebang.nvim

A Neovim plugin that inserts a shebang line when editing a new file.

shebang.nvim

A simple Neovim plugin written in Lua that automatically inserts a shebang line when editing a new file and makes it executable.

Installation

vim-plug

Plug "susensio/shebang.nvim"
lua require("shebang").setup()

packer

use {
    "susensio/shebang.nvim",
    config = function() require("shebang").setup() end
}

Usage

If a file extension is present, the pluggin works automatically. A manual user command is provided :Bang [<ext>] with an optional extension argument, usefull when editing previously created files or source files without extension.

-- Try to set shebang based on extension, or insert default shebang
:Bang

-- Force specific shebang by declaring extension
:Bang py

Customization

You can set custom shebangs or override defaults in setup with bins = { extension = binary }, using either a binary command (which will be resolved with /usr/bin/env) or a full path:

require("shebang").setup({
    bin = {
        ksh = "/usr/bin/ksh",
        py = "python3.11",
        scala = nil
    }
})

Default options are:

{
    bins = {
        awk = "awk",
        hs = "runhaskell",
        jl = "julia",
        lua = "lua",
        m = "octave",
        mak = "make",
        php = "php",
        pl = "perl",
        py = "python3",
        r = "Rscript",
        rb = "ruby",
        scala = "scala",
        sh = "bash",
        tcl = "tclsh",
        tk = "wish",
    },
    automatic = true,       -- insert shebang on new file
    command = true,         -- define Bang user command
    executable = true,      -- make file executable on exit
    default = "/bin/sh"     -- default shebang for `:Bang` without args
}

FAQ

Q: How does it differ from forked samirettali/shebang.nvim?

A: First, it only makes a file executable if the shebang is still present on exist. This prevent false positives. Second, a :Bang user command can manually add a shebang, helping with false negatives.