akiradeveloper / ijk

A real editor for real programmers

ijk

A real editor for real programmers.

Usage

• make install to install.
• ijk to start ijk with the current directory.
• KeyBindings
• Configurations

Design Doc

Design Doc

Features

ijk is similar to vi but with some differences:

• Word range: In vi, dw and cw affects the range from the current cursor position to the end of the word as if user started a visual mode and word-jumped. This behavior is rarely meaningful in software programming. Instead, dw and cw affects the entire word the cursor is on. This behavior is consistent with the char version of delete and replace (x and r) in a sense that they affect the object the cursor is on.
• Native directory explorer: ijk has a native implementation of directory explorer similar to Defx. This is because real software programming rarely end up with coding a single file but many files and directories in tree. With the explorer you can access to files and directories using line jump and string search as in text editting.
• Navigator: Navigator is the central part of ijk and you can switch to navigator anytime by pressing C-w. Navigator is like a stack of living pages. You can access to any open files, directories and other temporary pages like command selector and switch between them very quickly.
• Space prefix: vi's command prefix is often mistyped because it needs two keys (shift+;) pressed at the same time in US keyboard. ijk uses space to start command mode where you can w to save the file etc.

Tasks

• Syntax highlighting (probably the syntect is a good choice)
• Automated benchmarking (using flamer is planned) and performance optimization
• Code snippet
• User config
• Integration with language server
• Integration with Git

ijk's Issues

change log set

When shifting multiple lines with range+> or <, the undoing will undo the change line by line, no atomically. The natural behavior should be undoing atomically. Obviously we need a concept like change log set which is namely a set of change log which is undoable at once.

The change log set is, in database context, kind of transaction which contains multiple change set which is able to revert atomically later.

implement gg to jump to the top

As vi user, it is kind a weird to lack gg command but forced to 1G to jump to the top. But today I think it should have.

C-f and C-b should reach the end

C-f does not reach the end when there is shorter than one page distance to the end. This behavior is bit awkward compared to original vi. The cursor should reach the end as G jumps to the end. (pressing C-f continuously = G) So is C-b.

repeat the latest command by dot

The current ijk does not implement . to repeat the latest command because simply repeating the latest log may be invalid. For example, delete 4 chars when there is only 3 chars in the buffer, what would happen? This may lead to SEGV.

An idea is that apply_log should return Result and when it is Err the editor state is restored and the repeat command only succeed the log returns Ok.

support num command

In vi, user is able to repeat a command multiple times by num followed by the command (e.g. 4x to remove the character 4 times).

Currently, recognizing the num part is only to JUMP node on FSM. To make it possible for num part to cooperate with other commands, we may need to move the num part to INIT node, or add new edge from JUMP node (should be renamed to NUM btw).

Anyway, the change should be undoable atomically and the concept of change log set is implemented in prior.