Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brouberol/bo
My personal prose editor with vim-like navigation.
https://github.com/brouberol/bo
rust text-editor vim
Last synced: 2 months ago
JSON representation
My personal prose editor with vim-like navigation.
- Host: GitHub
- URL: https://github.com/brouberol/bo
- Owner: brouberol
- License: mit
- Created: 2021-07-20T13:36:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T02:58:17.000Z (almost 2 years ago)
- Last Synced: 2024-11-15T04:56:50.679Z (2 months ago)
- Topics: rust, text-editor, vim
- Language: Rust
- Homepage:
- Size: 2.88 MB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# bo
[](https://crates.io/crates/bo-bin) [](https://github.com/brouberol/bo/actions/workflows/tests.yml) [](http://github-brouberol-coverage.s3-website.eu-west-3.amazonaws.com/bo/main) [](https://brouberol.github.io/bo/doc/)
My (WIP) personal text editor for prose.
https://user-images.githubusercontent.com/480131/131999617-61acc5a2-4055-4cd1-9da1-134ee9e075b4.mp4
## Why?
The goals for `bo` are the following:
- write a non trivial application in Rust for the first time
- create a text editor extremely tailored to my personal tastes, only implementing the Vim navigation features I like and use
- make it _non configurable_
Having a good text editor is paramount for a software engineer, but the definition of _good_ really varies depending on the context.
I do enjoy Visual Studio for its rich ecosystem, I enjoy Sublime Text for its extreme snappiness, and I enjoy vim for its ubiquitousness.
I tend to favour an editor with plugins/linters/autocompletion when I'm developing code, but when I'm writing prose (blogposts, book chapters...), I would like to use an editor that is as simple as possible and "works" for me, without giving me the opportunity of getting lost in configuration options.
So, something like [Left](https://hundredrabbits.itch.io/left), but with vim-like navigation commands.
## Installation
You can fetch the latest `bo` release from the [Github release page](https://github.com/brouberol/bo/releases), or compile and install it by running
```console
$ cargo install bo-bin
```
**Note**: While the crates is named `bo-bin` (as [`bo`](https://crates.io/crates/bo) was already taken), the binary name is `bo`.
## Roadmap
### Navigation
- [x] Navigation with `h`, `j`, `k`, `l`
- [x] Next/previous paragraph (`}`, `{`)
- [x] Next/previous word (`w`, `b`)
- [x] First/last line in document (`g`, `G`)
- [x] First/last character in the line (`0`, `$`)
- [x] Screen navigation (`H`, `M`, `L`)
- [x] First non whitespace character in the line (`^`)
- [x] Support for multi-character commands (e.g. `2j`, `3}`, ...)
- [x] Go to n% in the file (`%`)
- [x] Search text and navigate through matches
- [x] Move cursor by left clicking
- [x] Go to matching symbol, bracket, quote, etc
- [x] Support multiline goto-matching-symbol
### Editing
- [x] Create a new file
- [x] Open an existing file
- [x] Save file `w`
- [x] Rename file `w` `file name`
- [x] Insert character under the cursor
- [ ] block (word, paragraph, line, etc) with both `d` and `c`
- [x] delete a line with `dd`
- [ ] yank/paste a block
- [x] insert newline before/after (`o`, `O`)
- [ ] Replace current character (`r`)
- [ ] Replace search matches
- [x] Remove trailing space at save
- [x] Remove current character
### Options
- [x] toggle line numbers
- [x] toggle word count stats
- [ ] toggle line wrapping
### UX
- [x] Display help
- [ ] Save session file with last known cursor position
- [x] Restore unsaved edits by regularly saving to a hidden swap file
- [ ] Command history, browsable with arrows
- [x] Support Unicode characters
- [x] Redraw rows when the terminal size changes
### Long shot
- [ ] Multiline edition support
- [x] undo/redo
- [ ] Tab navigation
- [ ] Fuzzy file finder
## Development documentation
The `rustdoc` documentation is hosted on [Github Pages](https://brouberol.github.io/bo/doc/).
## Inspiration
I got the inspiration for `bo` by reading about [antirez](https://github.com/antirez)'s editor [`kilo`](https://github.com/antirez/kilo), and am wildly basing my work on the excellent [blogpost series](https://www.philippflenker.com/hecto-chapter-1) by Philipp Flenker.
It is called `bo` because I've recently [turned 30](https://www.youtube.com/watch?v=XrOa5hDzXIY).