orinfar
a text editor for witches
Building
To build this project, first install Cargo, the Rust package manager, then clone this repo and cargo run in the project directory.
The editor is inspired by Vi, but has a few key differences, so you should read the user manual before using it in a meaningful manner.
Principles
Minimal
- A TUI text editor
- Simple but powerful and opinionated
- Not configurable
- Similar to base Vi, but with better defaults (lsp support, etc)
- Similar in princible to Helix, but more minimal
Reliable
- Ideally, all software should work exactly as documented and intented
- No implementation quirks
- No undocumented but "obvious" or "intuitive" behavior
- Not much else to say at the moment
User Manual
Please read the user manual before trying to edit text with Orinfar. While this text editor is mostly a subset of Vi, there are plenty of differences, both subtle and obvious.
Implementation
Eventually I'll get around to writing developer facing documentation.
Roadmap
I'll specify and revise this list when I get around to specific things and I have a better understanding of where I want to take this project
- Basic Vi Commands and Features (see the user manual)
- Additional Vi Features
- Undo System (not comprehensively documented)
- Redo System
- Status Bar (not comprehensively documented)
- Minimal Register System (not yet documented)
- Robust Register System (a poorly defined goal, at the moment)
- Mark System
- Multiple View Boxes
- Text Objects
- Advanced Features
- C Syntax Highlighting (tree-sitter)
- Markdown Syntax Highlighting
- Rust Syntax Highlighting
- LSP Client Support
- Important Chores
- Test Suite
- Benchmarking Suite
Feature/Bug Requests
If I haven't implemented your favorite Vi feature, or you've found some undesirable bug or behavior, feel free to reach out to me at azaleacolburn[AT]gmail[DOT]com. Please do note, however, that many discrepencies between orinfar and Vi are intentional.
Known Bugs
Please check the stable for the latest bug-free commit