initial working commit

Author: dchae

.DS_Store

@@ -1,2 +1,156 @@
-# canter
-lightweight neovim code runner plugin that works with Snacks.terminal
+# canter.nvim
+
+## Introduction
+
+lightweight neovim code runner plugin that works with Snacks.nvim terminal
+
+## Requirements
+
+- Neovim (>= 0.7)
+- [Snacks.nvim](https://github.com/folke/snacks.nvim) (>= 2.11.0)
+  - needed for Terminal
+- [which-key](https://github.com/folke/which-key.nvim) (>= 3.15.0)
+  - only needed for custom leader key menu group name
+
+## Installation
+
+### With [lazy.nvim](https://github.com/folke/lazy.nvim)
+
+```lua
+{
+   "dchae/canter.nvim",
+   opts = {}
+},
+```
+
+### Other package managers
+
+Install normally, and add this line to your `init.lua`:
+
+```lua
+require("canter.nvim").setup()
+```
+
+## Configuration
+
+Pass your config table into the `setup()` function or `opts` if you use lazy.nvim.
+
+### Options
+
+#### Default options
+```lua
+opts = {
+    -- File extension to runner/interpreter mapping
+    runners = {},
+
+    -- Terminal configuration (passed to Snacks.nvim)
+    Snacks_terminal_opts = {
+        win = {
+            position = "bottom",
+            relative = "editor"
+        },
+        interactive = false
+    },
+
+    -- Default keymaps (can be overridden)
+    keymaps = {
+        ["<leader><cr><cr>"] = {
+            cmd = ":CanterRun<CR>",
+            desc = "Run current file (Auto)"
+        },
+        ["<leader><cr>w"] = {
+            cmd = ":CanterWait<CR>",
+            desc = "Run current file (Wait)"
+        }
+    }
+}
+```
+
+**NOTE** - does not come with runners by default, you must add your own.
+
+- `runners`: table `([file_extension] = runner/interpreter)`
+- `Snacks_terminal_opts`: table of options passed to Snacks.nvim terminal
+  - `win`: window positioning options
+  - `interactive`: whether terminal starts in interactive mode
+- `keymaps`: table of keybindings and their descriptions
+
+#### Example config
+```lua
+opts = {
+    runners = {
+        ["js"] = "node", 
+        ["rb"] = "ruby", 
+        ["py"] = "python"
+    },
+    Snacks_terminal_opts = {
+        win = {
+            position = "right",  -- Change terminal position to right
+            relative = "editor"
+        },
+        interactive = true      -- Always start in interactive mode
+    }
+}
+```
+
+## Usage
+
+"Run current file (Auto)"
+
+- if file contains a shebang on the first line, the plugin will attempt to:
+  1. make the file executable via `chmod`
+  2. execute the current file
+- else, if the file has a corresponding runner
+  1. execute the current file via its runner in `Snacks.terminal`
+
+"Run current file (Wait)"
+
+- same as above, but stops before actually executing so you can add flags or confirm the command before pressing enter.
+  - necessarily, the terminal is interactive by default in this mode.
+
+### Shebang example with node
+`test.js`
+```js
+#!/usr/bin/env node
+
+console.log("Hello, world!");
+// "Hello, world!"
+```
+
+### Default Keybinds
+
+All keybinds can be customized in the config. The defaults are:
+
+- `<Leader><CR><CR>`: Run current file (Auto)
+  - executes current file in terminal
+  - default behaviour is non-interactive; file will run and then any key will dismiss terminal
+- `<Leader><CR>w`: Run current file (Wait)
+  - loads current file run command in terminal
+  - default behaviour is interactive
+
+To customize keybinds, modify the `keymaps` table in your config:
+
+```lua
+opts = {
+    keymaps = {
+        -- Override default run binding
+        ["<leader>r"] = {
+            cmd = ":CanterRun<CR>",
+            desc = "Run current file"
+        },
+        -- Add new binding
+        ["<leader>rw"] = {
+            cmd = ":CanterWait<CR>",
+            desc = "Run and wait"
+        }
+    }
+}
+```
+
+## Roadmap
+
+- should work with vsplit terminal when Snacks is not available
+- automatically scan and resolve runners for a given file extension
+- better support for runner flags
+
+## Credits
+- plugin inspired by keymap script by u/linkarzu on r/neovim

README.md

@@ -0,0 +1,114 @@
+-- Helper functions
+local function get_current_file_path()
+    local filepath = vim.fn.expand("%:p:.") -- Get the current filepath, relative to current dir if possible
+    return vim.fn.shellescape(filepath)
+end
+
+---@param runImmediately (boolean)
+---@param opts (table)
+local function run_current_file(runImmediately, opts)
+    local filepath = get_current_file_path()
+    local file_extension = vim.fn.expand("%:e")
+    local first_line = vim.fn.getline(1)
+
+    local runners = opts.runners
+    local snacks_opts = opts.Snacks_terminal_opts
+
+    if string.match(first_line, "^#!/") then -- If first line starts with shebang (e.g. #!/usr/bin/env node)
+        vim.cmd("!chmod +x " .. filepath) -- Make the file executable
+
+        if not string.match(filepath, "/") then -- if filepath is relative add "./"
+            filepath = "./" .. filepath
+        end
+
+        if runImmediately then
+            Snacks.terminal(filepath, snacks_opts)
+            vim.cmd("startinsert")
+        else
+            Snacks.terminal.open()
+            vim.cmd("startinsert")
+            vim.api.nvim_input(filepath)
+        end
+    elseif runners[file_extension] then -- if we have a valid runner for the filetype
+        local runner = runners[file_extension] -- Get runner
+        local cmd = runner .. " " .. filepath -- Runner and filepath (e.g. node script.js)
+        if runImmediately then
+            Snacks.terminal(cmd, snacks_opts)
+            vim.cmd("startinsert")
+        else
+            Snacks.terminal.open()
+            vim.cmd("startinsert")
+            vim.api.nvim_input(cmd)
+        end
+    else
+        vim.cmd("echo 'Error: Could not resolve interpreter or find shebang line.'")
+    end
+end
+
+local default_opts = { -- default options
+    runners = {},
+    Snacks_terminal_opts = {
+        win = {
+            position = "bottom",
+            relative = "editor"
+        },
+        interactive = false
+    },
+    keymaps = {
+        ["<leader><cr><cr>"] = {
+            cmd = ":CanterRun<CR>",
+            desc = "Run current file (Auto)"
+        },
+        ["<leader><cr>w"] = {
+            cmd = ":CanterWait<CR>",
+            desc = "Run current file (Wait)"
+        }
+    }
+}
+
+local M = {}
+
+---@param user_opts (table | nil)
+function M.setup(user_opts)
+    user_opts = user_opts or {}
+    local opts = vim.tbl_deep_extend("force", default_opts, user_opts)
+
+    local function run_current_file_auto()
+        run_current_file(true, opts) -- Pass the entire opts table, not just runners
+    end
+    local function run_current_file_wait()
+        run_current_file(false, opts) -- Pass the entire opts table, not just runners
+    end
+
+    -- Add keymaps if configured
+    if opts.keymaps then
+        for key, mapping in pairs(opts.keymaps) do
+            vim.keymap.set('n', key, mapping.cmd, {
+                desc = mapping.desc,
+                silent = true
+            })
+        end
+    end
+
+    -- Register which-key group
+    local ok, wk = pcall(require, "which-key")
+    if ok then
+        wk.add({{
+            "<leader><cr>",
+            group = "Canter (run code)"
+        }})
+    end
+
+    local commands = {
+        CanterRun = run_current_file_auto,
+        CanterWait = run_current_file_wait
+    }
+
+    for cmd, fn in pairs(commands) do
+        vim.api.nvim_create_user_command(cmd, fn, {
+            nargs = 0
+        })
+    end
+end
+
+return M

lua/canter/init.lua

@@ -0,0 +1,8 @@
+-- Prevent loading multiple times
+if vim.g.loaded_canter == 1 then
+    return
+end
+vim.g.loaded_canter = 1
+
+-- Require canter
+require("canter").setup()

plugin/canter.lua

@@ -0,0 +1,3 @@
+indent_type = "Spaces"
+indent_width = 3
+column_width = 80