chore: initial commit

Author: spywhere

.gitignore

@@ -0,0 +1 @@
+init.lua

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Sirisak Lueangsaksri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,2 @@
+testrun:
+	nvim -u tests/init.lua

README.md

@@ -0,0 +1,86 @@
+# tmux.nvim
+
+_This plugin still under development_
+
+This plugin provides a framework to turns
+[Neovim](https://github.com/neovim/neovim) into terminal multiplexer
+(heavily based on [tmux](https://github.com/tmux/tmux))
+
+The intention of this plugin is to eliminate the need of tmux for a basic
+terminal multiplexing feature by leveraging Neovim split and tab features
+
+## Table Of Contents
+
+* [Installation](#installation)
+* [Integration](#integration)
+* [Configuration](#configuration)
+* [Contributes](#contributes)
+* [License](#license)
+
+## Installation
+
+It is highly recommended to clone the repository (or download a zip file) and
+place it somewhere (`~/.tmux.nvim` would work too)
+
+```sh
+git clone https://github.com/spywhere/tmux.nvim ~/.tmux.nvim
+```
+
+or install using a plugin manager of your choice, for example:
+
+```viml
+" neovim 0.5 or later which support lsp and lua
+Plug 'itchyny/lightline.vim'    " Dependency: status line
+Plug 'spywhere/lightline-lsp'
+```
+
+## Integration
+
+Create a file named `init.lua` and place it somewhere
+(in this example, `~/.tmux.nvim/init.lua` will be used)
+
+```lua
+local tmux = require('tmux')
+
+-- some configurations go here
+
+tmux.start() -- this will start a terminal session
+
+```
+
+then, when you're ready to use Neovim as terminal multiplexer, just run
+
+```sh
+nvim -u ~/.tmux.nvim/init.lua
+```
+
+## Configuration
+
+As the plugin still under development, please find the default configurations
+from following locations...
+
+- Neovim configurations: `lua/tmux/config.lua`
+- Key bindings: `lua/tmux/bindings.lua`
+- Available commands: `lua/tmux/commands.lua`
+
+Please note that some options are opinionated and will be updated to match
+tmux's defaults later on
+
+## Contributes
+
+During the development, you can use the following command to automatically setup
+a working configurations to test the plugin...
+
+```
+make testrun
+```
+
+or
+
+```
+nvim -u tests/init.lua
+```
+
+## License
+
+Released under the [MIT License](LICENSE)

lua/tmux/bindings.lua

@@ -0,0 +1,14 @@
+local fn = require('tmux.lib.fn')
+local cmds = require('tmux.commands')
+
+return fn.nested(2, function (P, M)
+  M.bind('c', cmds.new_window())
+  M.bind('-', cmds.split_window({ 'h' }))
+  M.bind('<bar>', cmds.split_window({ 'v' }))
+  M.bind(':', cmds.command_prompt())
+
+  M.bind('<C-h>', cmds.select_pane({ 'L' }), { 'n' })
+  M.bind('<C-j>', cmds.select_pane({ 'D' }), { 'n' })
+  M.bind('<C-k>', cmds.select_pane({ 'U' }), { 'n' })
+  M.bind('<C-l>', cmds.select_pane({ 'R' }), { 'n' })
+end)

lua/tmux/commands.lua

@@ -0,0 +1,95 @@
+local fn = require('tmux.lib.fn')
+
+local M = {}
+
+M.new_window = function ()
+  return fn.nested(2, function ()
+    vim.cmd('terminal')
+  end)
+end
+M.neww = M.new_window
+
+M.command_prompt = function ()
+  return fn.nested(2, function ()
+    vim.cmd('stopinsert')
+    vim.api.nvim_feedkeys(':', 'n', true)
+  end)
+end
+
+M.send_prefix = function ()
+  return fn.nested(2, function (P)
+    vim.api.nvim_feedkeys(P.prefix, 't', true)
+  end)
+end
+
+M.kill_window = function ()
+  return fn.nested(2, function ()
+  end)
+end
+M.killw = M.kill_window
+
+M.previous_window = function ()
+  return fn.nested(2, function ()
+  end)
+end
+M.prev = M.pervious_window
+
+M.next_window = function ()
+  return fn.nested(2, function ()
+  end)
+end
+M.next = M.next_window
+
+M.select_window = function ()
+  return fn.nested(2, function ()
+  end)
+end
+M.selectw = M.select_window
+
+M.split_window = function (opts)
+  for key, value in pairs(opts) do
+    if type(key) == 'number' then
+      if value == 'h' then
+        return fn.nested(2, function ()
+          vim.cmd('split | terminal')
+        end)
+      elseif value == 'v' then
+        return fn.nested(2, function ()
+          vim.cmd('vsplit | terminal')
+        end)
+      end
+    end
+  end
+
+  return fn.nested(2)
+end
+M.splitw = M.split_window
+
+M.select_pane = function (opts)
+  for key, value in pairs(opts) do
+    if type(key) == 'number' then
+      if value == 'L' then
+        return fn.nested(2, function ()
+          vim.cmd('wincmd h')
+        end)
+      elseif value == 'D' then
+        return fn.nested(2, function ()
+          vim.cmd('wincmd j')
+        end)
+      elseif value == 'U' then
+        return fn.nested(2, function ()
+          vim.cmd('wincmd k')
+        end)
+      elseif value == 'R' then
+        return fn.nested(2, function ()
+          vim.cmd('wincmd l')
+        end)
+      end
+    end
+  end
+
+  return fn.nested(2)
+end
+M.selectp = M.select_pane
+
+return M

lua/tmux/config.lua

@@ -0,0 +1,21 @@
+local fn = require('tmux.lib.fn')
+
+return fn.nested(2, function ()
+  -- no status line
+  vim.o.laststatus = 0
+  vim.o.statusline = ' '
+  -- no command line
+  --   currently not possible
+  --   ref: https://github.com/neovim/neovim/issues/1004
+  -- vim.o.cmdheight = 0
+  -- workaround for hiding command line
+  vim.opt.lines:append(1)
+
+  -- remove command line clutter
+  vim.o.showmode = false
+  vim.o.showcmd = false
+  vim.o.ruler = false
+
+  vim.o.splitright = true
+  vim.o.splitbelow = true
+end)

lua/tmux/event.lua

@@ -0,0 +1,43 @@
+local fn = require('tmux.lib.fn')
+local registry = require('tmux.lib.registry')
+
+return fn.nested(2, function (P, M)
+  function start_insert()
+    vim.defer_fn(function ()
+      if vim.bo.buftype == 'terminal' then
+        vim.cmd('startinsert!')
+      end
+    end, 10)
+  end
+
+  registry.auto({ 'BufEnter', 'CmdlineLeave' }, start_insert)
+  registry.auto('TermOpen', 'startinsert!')
+
+  function on_window_close()
+    vim.defer_fn(function ()
+      local wins = vim.api.nvim_list_wins()
+
+      local count = 0
+      for _, win in ipairs(wins) do
+        local buffer = vim.api.nvim_win_get_buf(win)
+        local buffer_type = vim.api.nvim_buf_get_option(buffer, 'buftype')
+        if buffer_type == 'terminal' then
+          count = count + 1
+        end
+      end
+
+      if count == 0 then
+        vim.cmd('cquit! ' .. P.last_status)
+      end
+    end, 10)
+  end
+
+  function on_terminal_close(event)
+    P.last_status = event.status
+
+   on_window_close()
+  end
+
+  registry.auto('TermClose', 'call ' .. registry.call_for_fn(on_terminal_close, 'v:event'))
+  registry.auto('BufLeave', on_window_close)
+end)