VIgor is a fun side project of implementing a terminal based IDE written in Go based on Vim behaviour. This is my first project in Go so it therefore also acts as my entrypoint into coding in Go.
As this is a pet project I specifically wanted to implement the UI with a low-level library instead of using libraries such as tview. This project exists only as a way to try out Go through a fun side project.
To run from source simply execute
go run . -f yourfile
Editoris the top level component. It owns and manages all IDE features such as reading files, dealing with key inputs, etc.Screenwraps aGrid(see below) and is in charge of the main event loop which renders components.Gridwraps all renderable components and automatically sizes itself according to the CLI termsize.Drawablecomponents can be rendered with output. There are multiple types ofDrawablecomponents with different behaviour.
TextArea: For rendering and interacting with text.StatusBar: For displaying additional metadata in the main IDE view.Cmd: Used to run commands. Behaves similar to VIM command-line mode.FileBrowser: Renders and interacts with the underlying filesystem.
There are lots of features that still need to be implemented. This is a non-exhaustive list:
- Linenumbers in
TextArea - Buffer file reads
- When reading a file store text as a Rope
- Undo/redo
- x axis scroll within file
- LSP integration and syntax highlighting
- Reading a config when initiating the
Editor
- Smart cursor behaviour.
- Keeps track of x position when moving between lines of different length.
- Navigating a full file with y axis scroll (currently x axis is not supported).
- Inserting and removing characters.
- Full browsing of a repository with unlimited file nesting.
h,j,k,l: Cursor movement$: Go to end of line0: Go to beginning of lineg: Go to start of fileG: Go to end of filei, a: Enter insert mode:- Enter command mode
q,quit: Quit editor without savingw,write: Write changes to filee,edit: Enter file browser