feat: create flatnvim

Author: adamtabrams

.gitignore

@@ -13,3 +13,5 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+bin

README.md

@@ -1 +1,41 @@
-# flatnvim
+# About
+
+The goal of `flatnvim` is to make it easy to get the most out of [Neovim](https://neovim.io/)'s
+[terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html).
+When you open files from within the `Neovim` terminal, `flatnvim` will automatically add them
+to the current instance instead of creating a new nested one.
+This makes it easy to use all your favorite programs naturally from within `Neovim`.
+
+# Usage
+
+### Clone & Build
+You'll first need the `flatnvim` binary on you system.
+
+```sh
+git clone https://github.com/adamtabrams/flatnvim.git
+cd flatnvim
+./build.sh
+```
+
+### Environment Variables
+There are 3 environment variable to use with `flatnvim`
+Add them to the config file for your shell (.bashrc, .profile, .zprofile, etc)
+
+##### Required: set path to the actual editor.
+```sh
+export FLATNVIM_EDITOR="nvim"
+```
+- When `flatnvim` is called from your regular terminal, it will just pass through to this editor.
+
+##### Recommended: set the path to the `flatnvim` binary as your default terminal editor.
+```sh
+export EDITOR="$HOME/repos/flatnvim/bin/flatnvim"
+```
+- If you don't know what this should be, use the path printed by the build.sh script.
+- In addition, I personally make aliases to this: `alias vim="$EDITOR`
+
+##### Optional: set an extra nvim command to be executed when preventing nested instances.
+```sh
+export FLATNVIM_EXTRA_COMMAND="if exists(':AirlineRefresh') == 2 | AirlineRefresh | endif"
+```
+- I use the command above to refresh my status bar.

build.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+go build -o bin/ || { echo "failure"; exit 1; }
+echo "success"
+echo "path to the flatnvim binary: $PWD/bin/flatnvim"

go.mod

@@ -0,0 +1,5 @@
+module flatnvim
+
+go 1.17
+
+require github.com/neovim/go-client v1.1.7

go.sum

@@ -0,0 +1,4 @@
+github.com/neovim/go-client v1.1.3 h1:RrjcL8ZdFNtI+w77cp0uWyHZBu2X9fHTvztipdyoZB8=
+github.com/neovim/go-client v1.1.3/go.mod h1:R9QUduDri8OKS78u/rAvFZmaw6pPfdb+MiKq0JYnZ+c=
+github.com/neovim/go-client v1.1.7 h1:nQY7XwQwCQQ4DtUkXcTsxAlCFgS4D6mi0KMqrHvY0ew=
+github.com/neovim/go-client v1.1.7/go.mod h1:lec+fTkbKMMQEcbP9SdiCteZeAhdchUsw6I1MGcqBkc=

main.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"log"
+	"os"
+	"os/exec"
+
+	"github.com/neovim/go-client/nvim"
+)
+
+func main() {
+	log.SetFlags(0)
+
+	addr := os.Getenv("NVIM_LISTEN_ADDRESS")
+	if addr == "" {
+		editor := os.Getenv("FLATNVIM_EDITOR")
+
+		path, err := exec.LookPath(editor)
+		if err != nil {
+			log.Fatalf("command '%v' set with environment variable FLATNVIM_EDITOR is not in $PATH\n", editor)
+		}
+
+		cmd := exec.Command(path, os.Args[1:]...)
+		cmd.Stdin = os.Stdin
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+
+		if err := cmd.Run(); err != nil {
+			log.Fatal(err)
+		}
+		os.Exit(0)
+	}
+
+	files := os.Args[1:]
+	if len(files) == 0 {
+		log.Fatal("no arguments given")
+	}
+
+	v, err := nvim.Dial(addr)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer v.Close()
+
+	b := v.NewBatch()
+	for _, file := range files {
+		b.Command(":e " + file)
+	}
+	b.Command(":b term://")
+	b.Command(":bw!")
+
+	extraCmd := os.Getenv("FLATNVIM_EXTRA_COMMAND")
+	if extraCmd != "" {
+		b.Command(extraCmd)
+	}
+
+	if err := b.Execute(); err != nil {
+		log.Fatal(err)
+	}
+}