commit 85120eb606ea2c8bfbce2d9c759656eeee443915 · treybastian.com/nvim-jack-in

+21

LICENSE

···

       1
       1
       +
       MIT License

     

       2
       2
       +
       

     

       3
       3
       +
       Copyright (c) 2024 Trey Bastian 

     

       4
       4
       +
       

     

       5
       5
       +
       Permission is hereby granted, free of charge, to any person obtaining a copy

     

       6
       6
       +
       of this software and associated documentation files (the "Software"), to deal

     

       7
       7
       +
       in the Software without restriction, including without limitation the rights

     

       8
       8
       +
       to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

     

       9
       9
       +
       copies of the Software, and to permit persons to whom the Software is

     

       10
       10
       +
       furnished to do so, subject to the following conditions:

     

       11
       11
       +
       

     

       12
       12
       +
       The above copyright notice and this permission notice shall be included in all

     

       13
       13
       +
       copies or substantial portions of the Software.

     

       14
       14
       +
       

     

       15
       15
       +
       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

     

       16
       16
       +
       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

     

       17
       17
       +
       FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

     

       18
       18
       +
       AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

     

       19
       19
       +
       LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

     

       20
       20
       +
       OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

     

       21
       21
       +
       SOFTWARE.

+110

README.md

···

       1
       1
       +
       # nvim-jack-in

     

       2
       2
       +
       

     

       3
       3
       +
       ---

     

       4
       4
       +
       Jack in to CLJ & Leiningen REPLs from Neovim. Inspired by [vim-jack-in](https://github.com/clojure-vim/vim-jack-in)

     

       5
       5
       +
       

     

       6
       6
       +
       ## Installation

     

       7
       7
       +
       

     

       8
       8
       +
       ### Lazy

     

       9
       9
       +
       

     

       10
       10
       +
       ```lua

     

       11
       11
       +
       {'TreyBastian/nvim-jack-in', config = true}

     

       12
       12
       +
       ```

     

       13
       13
       +
       

     

       14
       14
       +
       #### Example with options

     

       15
       15
       +
       

     

       16
       16
       +
       ```lua

     

       17
       17
       +
       {

     

       18
       18
       +
         'TreyBastian/nvim-jack-in',

     

       19
       19
       +
         opts = {

     

       20
       20
       +
             location = 'vsplit',

     

       21
       21
       +
             force_powershell = true,

     

       22
       22
       +
         },

     

       23
       23
       +
         config = true,

     

       24
       24
       +
       }

     

       25
       25
       +
       ```

     

       26
       26
       +
       

     

       27
       27
       +
       ### Options

     

       28
       28
       +
       

     

       29
       29
       +
       #### `clj_dependencies`

     

       30
       30
       +
       

     

       31
       31
       +
       Dependencies that should be injected into clj

     

       32
       32
       +
       

     

       33
       33
       +
       ##### Default

     

       34
       34
       +
       

     

       35
       35
       +
       ```lua

     

       36
       36
       +
       clj_dependencies = {

     

       37
       37
       +
         { name = "nrepl/nrepl",       version = "RELEASE" },

     

       38
       38
       +
         { name = "cider/cider-nrepl", version = "RELEASE" },

     

       39
       39
       +
       }

     

       40
       40
       +
       ```

     

       41
       41
       +
       

     

       42
       42
       +
       #### `clj_middleware`

     

       43
       43
       +
       

     

       44
       44
       +
       Middleware that should be injected into clj

     

       45
       45
       +
       

     

       46
       46
       +
       ##### Default

     

       47
       47
       +
       

     

       48
       48
       +
       ```lua

     

       49
       49
       +
       clj_middleware = {

     

       50
       50
       +
         "cider.nrepl/cider-middleware"

     

       51
       51
       +
       }

     

       52
       52
       +
       ```

     

       53
       53
       +
       

     

       54
       54
       +
       #### `lein_plugins`

     

       55
       55
       +
       

     

       56
       56
       +
       Plugins that should be injected into leiningen

     

       57
       57
       +
       

     

       58
       58
       +
       ##### Default

     

       59
       59
       +
       

     

       60
       60
       +
       ```lua

     

       61
       61
       +
       lein_plugins = {

     

       62
       62
       +
         { name = "cider/cider-nrepl", version = "RELEASE" },

     

       63
       63
       +
       }

     

       64
       64
       +
       ```

     

       65
       65
       +
       

     

       66
       66
       +
       #### `location`

     

       67
       67
       +
       

     

       68
       68
       +
       Location where the REPL should open

     

       69
       69
       +
       

     

       70
       70
       +
       ##### Default

     

       71
       71
       +
       

     

       72
       72
       +
       ```lua

     

       73
       73
       +
       location = 'buffer'

     

       74
       74
       +
       ```

     

       75
       75
       +
       

     

       76
       76
       +
       ##### Choices

     

       77
       77
       +
       

     

       78
       78
       +
       `buffer` - opens REPL in a new buffer with focus

     

       79
       79
       +
       `background` - opens REPL in a new buffer but you stay focused on current buffer

     

       80
       80
       +
       `split` - opens REPL in new split

     

       81
       81
       +
       `vsplit` - opens REPL in new vertical split

     

       82
       82
       +
       `tab` - opens REPL in new tab

     

       83
       83
       +
       

     

       84
       84
       +
       #### `force_powershell`

     

       85
       85
       +
       

     

       86
       86
       +
       Force the usage of powershell. In windows setting `vim.o.shell = powershell` might sometimes not be optimal. Clj by default on windows is installed as a powershell module. This forces the plugin to use powershell.

     

       87
       87
       +
       

     

       88
       88
       +
       ##### Default

     

       89
       89
       +
       

     

       90
       90
       +
       ```lua

     

       91
       91
       +
       force_powershell = false

     

       92
       92
       +
       ```

     

       93
       93
       +
       

     

       94
       94
       +
       ## Usage

     

       95
       95
       +
       

     

       96
       96
       +
       This plugin automatically registers 2 commands `:Clj`and `:Lein` to start their respective REPLs

     

       97
       97
       +
       

     

       98
       98
       +
       You can easily map these commands to a key.

     

       99
       99
       +
       

     

       100
       100
       +
       ```lua

     

       101
       101
       +
       vim.keymap.set("n", "<leader>rc", "<CMD>:Clj<CR>")

     

       102
       102
       +
       vim.keymap.net("n", "<leader>rl", "<CMD>:Lein<CR>")

     

       103
       103
       +
       ```

     

       104
       104
       +
       

     

       105
       105
       +
       You can supply additional arguments to the command. For example to use [Kit-Clj](https://kit-clj.github.io) development mode you can do.

     

       106
       106
       +
       `:Clj -A:dev`

     

       107
       107
       +
       

     

       108
       108
       +
       ## Contributing

     

       109
       109
       +
       

     

       110
       110
       +
       This project is open source, not just public source. If you wish to contribute start with an issue.

+115

lua/nvim-jack-in.lua

···

       1
       1
       +
       local vim = vim

     

       2
       2
       +
       local M = {}

     

       3
       3
       +
       

     

       4
       4
       +
       M.config = {

     

       5
       5
       +
       	-- clj dependencies

     

       6
       6
       +
       	clj_dependencies = {

     

       7
       7
       +
       		{ name = "nrepl/nrepl", version = "RELEASE" },

     

       8
       8
       +
       		{ name = "cider/cider-nrepl", version = "RELEASE" },

     

       9
       9
       +
       	},

     

       10
       10
       +
       	-- clj middleware

     

       11
       11
       +
       	clj_middleware = {

     

       12
       12
       +
       		"cider.nrepl/cider-middleware",

     

       13
       13
       +
       	},

     

       14
       14
       +
       	-- leiningen plugins

     

       15
       15
       +
       	lein_plugins = {

     

       16
       16
       +
       		{ name = "cider/cider-nrepl", version = "RELEASE" },

     

       17
       17
       +
       	},

     

       18
       18
       +
       	-- buffer, background, vsplit, split, tab

     

       19
       19
       +
       	location = "buffer",

     

       20
       20
       +
       	force_powershell = false,

     

       21
       21
       +
       }

     

       22
       22
       +
       

     

       23
       23
       +
       local function is_powershell()

     

       24
       24
       +
       	return vim.o.shell == "powershell.exe"

     

       25
       25
       +
       		or vim.o.shell == "pwsh"

     

       26
       26
       +
       		or vim.o.shell == "powershell"

     

       27
       27
       +
       		or vim.o.shell == "pwsh.exe"

     

       28
       28
       +
       		or M.config.force_powershell == true

     

       29
       29
       +
       end

     

       30
       30
       +
       

     

       31
       31
       +
       -- windows needs to add quotes for powershell because well powershell...

     

       32
       32
       +
       local function version_escape(version)

     

       33
       33
       +
       	if is_powershell() == true then

     

       34
       34
       +
       		return '""""""' .. version .. '""""""'

     

       35
       35
       +
       	end

     

       36
       36
       +
       	return '"' .. version .. '"'

     

       37
       37
       +
       end

     

       38
       38
       +
       

     

       39
       39
       +
       local function map_clj_deps_to_string()

     

       40
       40
       +
       	local string = ""

     

       41
       41
       +
       	for _, v in pairs(M.config.clj_dependencies) do

     

       42
       42
       +
       		string = string .. v.name .. " {:mvn/version " .. version_escape(v.version) .. "} "

     

       43
       43
       +
       	end

     

       44
       44
       +
       	return string

     

       45
       45
       +
       end

     

       46
       46
       +
       

     

       47
       47
       +
       local function map_clj_middleware_to_string()

     

       48
       48
       +
       	local string = ""

     

       49
       49
       +
       	for _, v in pairs(M.config.clj_middleware) do

     

       50
       50
       +
       		string = string .. '"' .. v .. '" '

     

       51
       51
       +
       	end

     

       52
       52
       +
       	return string

     

       53
       53
       +
       end

     

       54
       54
       +
       

     

       55
       55
       +
       local function clj_string(args)

     

       56
       56
       +
       	if args == nil then

     

       57
       57
       +
       		args = ""

     

       58
       58
       +
       	end

     

       59
       59
       +
       

     

       60
       60
       +
       	local cmd = "clj"

     

       61
       61
       +
       	local deps = "'{:deps {" .. map_clj_deps_to_string() .. "}}' "

     

       62
       62
       +
       	local cider = "-M -m nrepl.cmdline --interactive --middleware '[" .. map_clj_middleware_to_string() .. "]'"

     

       63
       63
       +
       

     

       64
       64
       +
       	return cmd .. " -Sdeps " .. deps .. args .. " " .. cider

     

       65
       65
       +
       end

     

       66
       66
       +
       

     

       67
       67
       +
       local function map_lein_plugins_to_string()

     

       68
       68
       +
       	local string = ""

     

       69
       69
       +
       	for _, v in pairs(M.config.lein_plugins) do

     

       70
       70
       +
       		string = string .. v.name .. " " .. version_escape(v.version) .. " "

     

       71
       71
       +
       	end

     

       72
       72
       +
       	return string

     

       73
       73
       +
       end

     

       74
       74
       +
       

     

       75
       75
       +
       local function lein_string(args)

     

       76
       76
       +
       	if args == nil then

     

       77
       77
       +
       		args = ""

     

       78
       78
       +
       	end

     

       79
       79
       +
       

     

       80
       80
       +
       	return "lein update-in :plugins conj '[" .. map_lein_plugins_to_string() .. "]' -- repl" .. args

     

       81
       81
       +
       end

     

       82
       82
       +
       

     

       83
       83
       +
       local function jack_in(execution_string)

     

       84
       84
       +
       	if M.config.location == "vsplit" then

     

       85
       85
       +
       		vim.cmd("vsplit")

     

       86
       86
       +
       	elseif M.config.location == "split" then

     

       87
       87
       +
       		vim.cmd("split")

     

       88
       88
       +
       	elseif M.config.location == "tab" then

     

       89
       89
       +
       		vim.cmd("tabnew")

     

       90
       90
       +
       	end

     

       91
       91
       +
       

     

       92
       92
       +
       	if M.config.force_powershell == true then

     

       93
       93
       +
       		vim.cmd(":term powershell " .. execution_string)

     

       94
       94
       +
       	else

     

       95
       95
       +
       		vim.cmd(":term " .. execution_string)

     

       96
       96
       +
       	end

     

       97
       97
       +
       	if M.config.location == "background" then

     

       98
       98
       +
       		-- swap to the previous buffer if available

     

       99
       99
       +
       		vim.cmd("bp")

     

       100
       100
       +
       	end

     

       101
       101
       +
       end

     

       102
       102
       +
       

     

       103
       103
       +
       function M.setup(user_opts)

     

       104
       104
       +
       	M.config = vim.tbl_extend("force", M.config, user_opts or {})

     

       105
       105
       +
       

     

       106
       106
       +
       	vim.api.nvim_create_user_command("Clj", function(opts)

     

       107
       107
       +
       		jack_in(clj_string(opts.args))

     

       108
       108
       +
       	end, { nargs = "*" })

     

       109
       109
       +
       

     

       110
       110
       +
       	vim.api.nvim_create_user_command("Lein", function(opts)

     

       111
       111
       +
       		jack_in(lein_string(opts.args))

     

       112
       112
       +
       	end, { nargs = "*" })

     

       113
       113
       +
       end

     

       114
       114
       +
       

     

       115
       115
       +
       return M