Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivangael/go-terminal-editor
Terminal-based text editor written in Go (ex: vim)
https://github.com/ivangael/go-terminal-editor
go golang terminal-app terminal-based terminal-editor vim
Last synced: 3 days ago
JSON representation
Terminal-based text editor written in Go (ex: vim)
- Host: GitHub
- URL: https://github.com/ivangael/go-terminal-editor
- Owner: IvanGael
- Created: 2024-09-14T14:51:06.000Z (13 days ago)
- Default Branch: main
- Last Pushed: 2024-09-16T20:38:38.000Z (11 days ago)
- Last Synced: 2024-09-17T01:43:20.359Z (11 days ago)
- Topics: go, golang, terminal-app, terminal-based, terminal-editor, vim
- Language: Go
- Homepage: https://codingchallenges.substack.com/p/coding-challenge-73-text-editor
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go Terminal Text Editor
## Description
This project is a lightweight, terminal-based text editor written in Go. It provides a vim-like interface with basic text editing capabilities, search functionality, and file management features. The editor is designed to be efficient and easy to use, making it suitable for quick edits and working in terminal environments.
## Features
- Vim-like modal editing (Normal, Insert, Search modes)
- Basic text manipulation (insert, delete, copy, paste)
- File operations (open, save)
- Search functionality with highlighting
- Undo/Redo capabilities
- Line numbering
- Status bar with file and cursor information
## Installation
### Prerequisites
- Go 1.16 or higher
- Git
### Steps
1. Clone the repository:
```
git clone https://github.com/IvanGael/Go-terminal-editor.git
cd Go-terminal-editor
```
2. Install dependencies:
```
go get
```
3. Build the project:
```
go build -o editor
```
## Usage
To start the editor, run:
```
./editor [filename]
```
If a filename is provided, the editor will open that file. Otherwise, it will start with a blank document.
### Key Bindings
#### Normal Mode
- `i`: Enter Insert mode
- `h`, `j`, `k`, `l` or arrow keys: Move cursor
- `x`: Delete character under cursor
- `dd`: Delete current line
- `yy`: Yank (copy) current line
- `p`: Paste yanked or deleted content
- `/`: Enter Search mode
- `n`: Find next occurrence
- `N`: Find previous occurrence
- `u`: Undo
- `Ctrl+r`: Redo
- `:w`: Save file
- `:q`: Quit (will warn if unsaved changes)
- `:q!`: Force quit without saving
#### Insert Mode
- `Esc`: Return to Normal mode
- Any character: Insert at cursor position
- `Enter`: Insert new line
- `Backspace`: Delete character before cursor
#### Search Mode
- Type to enter search term
- `Enter`: Confirm search and return to Normal mode
- `Esc`: Cancel search and return to Normal mode
## Configuration
The editor uses some default settings that can be modified in the source code:
- Tab size: 4 spaces (adjustable in the `initialModel` function)
- Color scheme: Can be modified by changing the ANSI color codes in the `View` function
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
## Acknowledgements
This project uses the following open-source libraries:
- [Bubble Tea](https://github.com/charmbracelet/bubbletea) for terminal UI
- [Lip Gloss](https://github.com/charmbracelet/lipgloss) for styling
- [golang.org/x/term](https://pkg.go.dev/golang.org/x/term) for terminal handling