136 lines
5.0 KiB
Markdown
136 lines
5.0 KiB
Markdown
[](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=29&branchName=master)
|
|
[](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=29&branchName=master)
|
|
[](https://results.pre-commit.ci/latest/github/asottile/babi/master)
|
|
|
|
|
|
|
|
babi
|
|
====
|
|
|
|
a text editor, eventually...
|
|
|
|
### installation
|
|
|
|
`pip install babi`
|
|
|
|
### why is it called babi?
|
|
|
|
I used to use the text editor `nano`, frequently I typo this. on a qwerty
|
|
keyboard, when the right hand is shifted left by one, `nano` becomes `babi`.
|
|
|
|
### babi vs. nano
|
|
|
|
here is a youtube video where I discuss the motivation for creating and using
|
|
`babi` instead of `nano`:
|
|
|
|
[](https://youtu.be/WyR1hAGmR3g)
|
|
|
|
### quitting babi
|
|
|
|
currently you can quit `babi` by using <kbd>^X</kbd> (or via <kbd>esc</kbd> +
|
|
<kbd>:q</kbd>).
|
|
|
|
### key combinations
|
|
|
|
these are all of the current key bindings in babi
|
|
|
|
- <kbd>^S</kbd>: save
|
|
- <kbd>^O</kbd>: save as
|
|
- <kbd>^X</kbd>: quit
|
|
- <kbd>^P</kbd>: open file
|
|
- arrow keys: movement
|
|
- <kbd>^A</kbd> / <kbd>home</kbd>: move to beginning of line
|
|
- <kbd>^E</kbd> / <kbd>end</kbd>: move to end of line
|
|
- <kbd>^Y</kbd> / <kbd>pageup</kbd>: move up one page
|
|
- <kbd>^V</kbd> / <kbd>pagedown</kbd>: move down one page
|
|
- <kbd>^-left</kbd> / <kbd>^-right</kbd>: jump by word
|
|
- <kbd>^-home</kbd> / <kbd>^-end</kbd>: jump to beginning / end of file
|
|
- <kbd>^_</kbd>: jump to line number
|
|
- selection: <kbd>shift</kbd> + ...: extend the current selection
|
|
- arrow keys
|
|
- <kbd>home</kbd> / <kbd>end</kdb>
|
|
- <kbd>pageup</kbd> / <kbd>pagedown</kbd>
|
|
- <kbd>^-left</kbd> / <kbd>^-right</kbd>
|
|
- <kbd>^-end</kbd> / <kbd>^-home</kbd>
|
|
- <kbd>tab</kbd> / <kbd>shift-tab</kbd>: indent or dedent current line (or
|
|
selection)
|
|
- <kbd>^K</kbd> / <kbd>^U</kbd>: cut and uncut the current line (or selection)
|
|
- <kbd>M-u</kbd> / <kbd>M-U</kbd> or <kbd>M-e</kbd>: undo / redo
|
|
- <kbd>^W</kbd>: search
|
|
- <kbd>^\\</kbd>: search and replace
|
|
- <kbd>^C</kbd>: show the current position in the file
|
|
- <kbd>^-up</kbd> / <kbd>^-down</kbd>: scroll screen by a single line
|
|
- <kbd>M-left</kbd> / <kbd>M-right</kbd>: go to previous / next file
|
|
- <kbd>^Z</kbd>: background
|
|
- <kbd>esc</kbd>: open the command mode
|
|
- <kbd>:q</kbd>: quit
|
|
- <kbd>:w</kbd>: write the file
|
|
- <kbd>:wq</kbd>: write the file and quit
|
|
- <kbd>:sort</kbd>: sort the file (or selection)
|
|
|
|
in prompts (search, search replace, command):
|
|
- <kbd>^C</kbd>: cancel
|
|
- <kbd>^K</kbd>: cut to end
|
|
- <kbd>^R</kbd>: reverse search
|
|
|
|
### setting up syntax highlighting
|
|
|
|
the syntax highlighting setup is a bit manual right now
|
|
|
|
1. find a visual studio code theme, convert it to json (if it is not already
|
|
json) and put it at `~/.config/babi/theme.json`. a helper script is
|
|
provided to make this easier: `./bin/download-theme NAME URL`
|
|
|
|
here's a modified vs dark plus theme that works:
|
|
|
|
```bash
|
|
./bin/download-theme vs-dark-asottile https://gist.github.com/asottile/b465856c82b1aaa4ba8c7c6314a72e13/raw/22d602fb355fb12b04f176a733941ba5713bc36c/vs_dark_asottile.json
|
|
```
|
|
|
|
### keyboard shortcuts on macos
|
|
|
|
to get the most out of babi's built in keyboard shortcuts, a few settings must
|
|
be changed on macos with Terminal.app:
|
|
|
|
- in **System Preferences**: **Keyboard** > **Shortcuts** >
|
|
**Mission Control**: disable or rebind "Move left a space" and
|
|
"Move right a space" (the defaults `⌃ →` and `⌃ ←` conflict)
|
|
- in **Terminal.app**: **Terminal** > **Preferences** > **Profiles** >
|
|
**Keyboard**:
|
|
- check **Use Option as Meta key**
|
|
- ensure the following keys are enabled:
|
|
- `⌃ →`: `\033[1;5C`
|
|
- `⌃ ←`: `\033[1;5D`
|
|
- `⇧ ↑`: `\033[1;2A`
|
|
- `⇧ ↓`: `\033[1;2B`
|
|
- `⇧ →`: `\033[1;2C`
|
|
- `⇧ ←`: `\033[1;2D`
|
|
|
|
## demos
|
|
|
|
most things work! here's a few screenshots
|
|
|
|
### file view
|
|
|
|
this opens the file, displays it, and can be edited and can save! unknown keys
|
|
are displayed as errors in the status bar. babi will scroll if the cursor
|
|
goes off screen either from resize events or from movement. babi can edit
|
|
multiple files. babi has a command mode (so you can quit it like vim
|
|
<kbd>:q</kbd>!). babi also supports syntax highlighting
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|