cmd
→
README
T
Cursor
T
Document
T
DriverResult
T
Editor
- ::add_newline_aboveEditor::add_newline_above
- ::add_newline_belowEditor::add_newline_below
- ::apply_commandEditor::apply_command
- ::apply_editor_commandEditor::apply_editor_command
- ::apply_keyEditor::apply_key
- ::backspaceEditor::backspace
- ::buffer_textEditor::buffer_text
- ::change_number_under_cursorEditor::change_number_under_cursor
- ::change_selectionEditor::change_selection
- ::change_selection_without_yankEditor::change_selection_without_yank
- ::character_infoEditor::character_info
- ::collapse_selectionEditor::collapse_selection
- ::delete_charEditor::delete_char
- ::delete_lineEditor::delete_line
- ::delete_selectionEditor::delete_selection
- ::delete_selection_without_yankEditor::delete_selection_without_yank
- ::delete_surroundEditor::delete_surround
- ::delete_to_line_endEditor::delete_to_line_end
- ::delete_to_line_startEditor::delete_to_line_start
- ::delete_word_backwardEditor::delete_word_backward
- ::delete_word_forwardEditor::delete_word_forward
- ::enter_insertEditor::enter_insert
- ::enter_normalEditor::enter_normal
- ::enter_selectEditor::enter_select
- ::extend_selection_to_line_boundsEditor::extend_selection_to_line_bounds
- ::find_char_backwardEditor::find_char_backward
- ::find_char_forwardEditor::find_char_forward
- ::flip_selectionEditor::flip_selection
- ::indent_selectionEditor::indent_selection
- ::insert_at_line_endEditor::insert_at_line_end
- ::insert_at_line_startEditor::insert_at_line_start
- ::insert_charEditor::insert_char
- ::insert_completionEditor::insert_completion
- ::insert_textEditor::insert_text
- ::is_selectedEditor::is_selected
- ::join_linesEditor::join_lines
- ::lower_selectionEditor::lower_selection
- ::match_bracketEditor::match_bracket
- ::move_downEditor::move_down
- ::move_file_endEditor::move_file_end
- ::move_file_startEditor::move_file_start
- ::move_leftEditor::move_left
- ::move_line_endEditor::move_line_end
- ::move_line_first_non_whitespaceEditor::move_line_first_non_whitespace
- ::move_line_startEditor::move_line_start
- ::move_next_long_wordEditor::move_next_long_word
- ::move_next_long_word_endEditor::move_next_long_word_end
- ::move_next_wordEditor::move_next_word
- ::move_next_word_endEditor::move_next_word_end
- ::move_paragraph_nextEditor::move_paragraph_next
- ::move_paragraph_prevEditor::move_paragraph_prev
- ::move_prev_long_wordEditor::move_prev_long_word
- ::move_prev_wordEditor::move_prev_word
- ::move_rightEditor::move_right
- ::move_to_columnEditor::move_to_column
- ::move_upEditor::move_up
- ::open_aboveEditor::open_above
- ::open_belowEditor::open_below
- ::paste_afterEditor::paste_after
- ::paste_beforeEditor::paste_before
- ::redoEditor::redo
- ::renderEditor::render
- ::replace_rangeEditor::replace_range
- ::replace_selection_with_charEditor::replace_selection_with_char
- ::replace_surroundEditor::replace_surround
- ::replace_with_yankedEditor::replace_with_yanked
- ::saveEditor::save
- ::save_asEditor::save_as
- ::search_backwardEditor::search_backward
- ::search_forwardEditor::search_forward
- ::search_word_under_cursorEditor::search_word_under_cursor
- ::select_allEditor::select_all
- ::select_lineEditor::select_line
- ::select_textobjectEditor::select_textobject
- ::selected_textEditor::selected_text
- ::selection_boundsEditor::selection_bounds
- ::set_statusEditor::set_status
- ::split_lineEditor::split_line
- ::surround_selectionEditor::surround_selection
- ::switch_selection_caseEditor::switch_selection_case
- ::toggle_block_commentEditor::toggle_block_comment
- ::toggle_line_commentEditor::toggle_line_comment
- ::trim_selectionEditor::trim_selection
- ::undoEditor::undo
- ::unindent_selectionEditor::unindent_selection
- ::upper_selectionEditor::upper_selection
- ::word_under_cursorEditor::word_under_cursor
- ::yank_lineEditor::yank_line
- ::yank_selectionEditor::yank_selection
T
EditorCommand
T
Mode
T
WordCategory
V
document
V
empty_editor
V
load
V
open_text
V
parse_script
V
parse_script_line
V
run_commands

meolix

A terminal Helix-like text editor implemented in MoonBit with moonbitlang/async.

editor

helix

async

moon add Yoorkin/meolix@0.1.0

Download zip

Author

Yoorkin

Version

0.1.0

License

Apache-2.0

Repository

github.com/Yoorkin/meolix

Last updated

2 months ago

Downloads

Dependencies

moonbitlang/async0.19.1
moonbit-community/fuzzy_match0.2.5

README

#Yoorkin/meolix

meolix is a terminal Helix-like text editor written in MoonBit.

The editor logic, buffer model, modal state, selection operations, command handling, rendering, and async file IO are implemented in MoonBit. A small native C terminal bridge is used only for OS terminal control: raw keyboard input, ANSI/VT mode, terminal restore, and window size.

#Run

This project targets MoonBit native because it uses moonbitlang/async and a native terminal bridge. On macOS and other Unix-like systems, run:

moon check --target native
moon test --target native
moon run --target native cmd/mx -- notes.txt
moon run --target native cmd/mx -- --help

On Windows, run native builds from a Visual Studio Developer shell, or initialize it first:

$bat = 'C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\Tools\VsDevCmd.bat'
$cmd = '"' + $bat + '" -arch=x64 && moon run --target native cmd/mx -- notes.txt'
cmd.exe /c $cmd

The same MoonBit commands then apply:

moon check --target native
moon test --target native
moon run --target native cmd/mx -- notes.txt
moon run --target native cmd/mx -- --help

On macOS, enable Option-as-Meta in your terminal profile if you want Alt-* bindings such as Alt-d and Alt-.; otherwise Option combinations are delivered as normal Unicode text input.

#Interactive Keys

Key meanings follow the basic normal/insert/select mappings from the Helix keymap: https://docs.helix-editor.com/keymap.html.
h/j/k/l or arrows move the cursor.
w/e/b and W/E/B move by word starts and word ends.
f/t/F/T<char> finds or moves till the next/previous character. Like Helix, this is not limited to the current line.
gg, ge, gh, gl, gs, and gf jump to the file start/end, line start/end, first non-whitespace character, and file path under the cursor.
G jumps to a line number; with a count, for example 42G, it jumps directly.
ga, gm, and g. jump to the alternate file, last modified file, and last modification location.
PgUp/PgDn, Ctrl-B/F, and Ctrl-U/D move by page or half-page.
Alt-. repeats the last supported motion from f/t/F/T, m m, [, or ] commands.
Ctrl-S, Ctrl-O, and Ctrl-I/Tab save the current location to the jumplist, jump backward, and jump forward.
Counts work for common movement keys, for example 10j and 42G.
i, a, I, A, o, and O enter insert mode, append, insert at line start/end, open below, and open above.
Esc returns to normal mode or cancels the prompt.
v enters select mode.
x, %, ;, and Alt-; select the current line, select the whole file, collapse selection, and flip selection anchor/cursor.
y, d, c, p, and P yank, delete, change, paste after, and paste before the current selection.
r<char>, R, J, ~, ` , and `Alt-`` replace with a character, replace with yanked text, join lines, switch case, lowercase, and uppercase.
u and U undo and redo.
m m matches brackets.
m a <object> and m i <object> select around/inside basic text objects: w, W, p, brackets, braces, angles, quotes, and backticks.
[p, ]p, [Space, and ]Space move by paragraph or add blank lines above/below.
[g, ]g, [G, and ]G navigate previous, next, first, and last git change for the current file using git diff --unified=0.
zt, zz, and zb align the cursor line to top, center, and bottom.
zm horizontally centers the cursor in the viewport.
Space opens a Helix-style which-key menu. Implemented entries include Space f workspace-root file fuzzy picker, Space F current-directory file picker, Space b buffer picker, Space j jumplist picker, Space g changed-file picker, Space ? command palette, Space / workspace-root line search picker, Space ' reopen last picker, Space c comments, Space C block comments, and Space Alt-c line comments.
Space y, Space p, Space P, and Space R use the system clipboard for yank, paste-after, paste-before, and replace. On Windows this uses PowerShell's clipboard commands; on Unix-like systems it tries pbcopy, wl-copy, xclip, or xsel.
MoonBit LSP integration includes gd, gy, gi, gr, Space k, Space s, Space S, Space d, Space D, Space r, Space a, and insert Ctrl-X for definition, type definition, implementation, references, hover, symbols, diagnostics, rename, code actions, and completion.
Pickers render a Helix-style list plus preview pane. Tab/Down/Ctrl-n select the next entry, Shift-Tab/Up/Ctrl-p select the previous entry, PageUp/PageDown page through matches, Ctrl-t toggles preview, Enter opens the selected entry, and Esc closes the picker.
Hover/info popups support Ctrl-D and Ctrl-U scrolling.
Picker filtering supports basic fzf-style terms: space-separated terms are combined with AND, !term excludes matches, and %path, %text, %line, or %command restrict following terms to a column.
: opens the command prompt.
/ opens the search prompt, n selects the next match, and N selects the previous match.
:w saves.
Ctrl-Q quits; press it twice when the buffer is dirty.
Insert mode supports Ctrl-W, Alt-D, Ctrl-U, Ctrl-K, and Ctrl-D for word, line, and character deletion, plus arrows, Home, End, Backspace, Delete, Enter, Ctrl-R register insertion, Ctrl-S undo checkpoint, and Ctrl-X LSP completion.

Not yet included: tree-sitter syntax-node text objects, true multi-window split layout, macros, shell filters, and signature-help behavior. These are not listed in meolix's in-editor key prompts until they are backed by working behavior.

#Commands

:w writes the file.
:w path writes to path and updates the current buffer path.
:q quits when the buffer is clean.
:q! quits even when the buffer is dirty.
:wq writes and quits.
:go N jumps to line N.
:open path, :edit path, and :e path switch to another file; dirty buffers stay open in memory and can be returned to from the buffer picker.
:new opens a scratch buffer when the current buffer is clean.
:insert TEXT inserts text at the cursor.
:append TEXT appends text to the current line.
Prompt history follows Helix-style navigation: Ctrl-P/Up selects the previous command or search entry, and Ctrl-N/Down moves forward.

#Headless Testing

The executable supports scripted runs for tests and CI. This is not the editor UI; normal use should launch the terminal interface without --cmd or --script.

moon run --target native cmd/mx -- notes.txt --headless --cmd ":go 2" --cmd "key x" --cmd "key y"
moon run --target native cmd/mx -- notes.txt --headless --script edit.meolix

Script format:

# comments are ignored
:go 2
key x
key y
key p
text inserted text

meolix

#Yoorkin/meolix

#Run

#Interactive Keys

#Commands

#Headless Testing

#Cursor

#Document

#DriverResult

#Editor

#Editor::add_newline_above

#Editor::add_newline_below

#Editor::apply_command

#Editor::apply_editor_command

#Editor::apply_key

#Editor::backspace

#Editor::buffer_text

#Editor::change_number_under_cursor

#Editor::change_selection

#Editor::change_selection_without_yank

#Editor::character_info

#Editor::collapse_selection

#Editor::delete_char

#Editor::delete_line

#Editor::delete_selection

#Editor::delete_selection_without_yank

#Editor::delete_surround

#Editor::delete_to_line_end

#Editor::delete_to_line_start

#Editor::delete_word_backward

#Editor::delete_word_forward

#Editor::enter_insert

#Editor::enter_normal

#Editor::enter_select

#Editor::extend_selection_to_line_bounds

#Editor::find_char_backward

#Editor::find_char_forward

#Editor::flip_selection

#Editor::indent_selection

#Editor::insert_at_line_end

#Editor::insert_at_line_start

#Editor::insert_char

#Editor::insert_completion

#Editor::insert_text

#Editor::is_selected

#Editor::join_lines

#Editor::lower_selection

#Editor::match_bracket

#Editor::move_down

#Editor::move_file_end

#Editor::move_file_start

#Editor::move_left

#Editor::move_line_end

#Editor::move_line_first_non_whitespace

#Editor::move_line_start

#Editor::move_next_long_word

#Editor::move_next_long_word_end

#Editor::move_next_word

#Editor::move_next_word_end

#Editor::move_paragraph_next

#Editor::move_paragraph_prev

#Editor::move_prev_long_word

#Editor::move_prev_word

#Editor::move_right

#Editor::move_to_column

#Editor::move_up

#Editor::open_above

#Editor::open_below

#Editor::paste_after

#Editor::paste_before

#Editor::redo

#Editor::render

#Editor::replace_range

#Editor::replace_selection_with_char

#Editor::replace_surround

#Editor::replace_with_yanked

#Editor::save

#Editor::save_as

#Editor::search_backward

#Editor::search_forward

#
Cursor

#
Document

#
DriverResult

#
Editor

#
Editor::add_newline_above

#
Editor::add_newline_below

#
Editor::apply_command

#
Editor::apply_editor_command

#
Editor::apply_key

#
Editor::backspace

#
Editor::buffer_text

#
Editor::change_number_under_cursor

#
Editor::change_selection

#
Editor::change_selection_without_yank

#
Editor::character_info

#
Editor::collapse_selection

#
Editor::delete_char

#
Editor::delete_line

#
Editor::delete_selection

#
Editor::delete_selection_without_yank

#
Editor::delete_surround

#
Editor::delete_to_line_end

#
Editor::delete_to_line_start

#
Editor::delete_word_backward

#
Editor::delete_word_forward

#
Editor::enter_insert

#
Editor::enter_normal

#
Editor::enter_select

#
Editor::extend_selection_to_line_bounds

#
Editor::find_char_backward

#
Editor::find_char_forward

#
Editor::flip_selection

#
Editor::indent_selection

#
Editor::insert_at_line_end

#
Editor::insert_at_line_start

#
Editor::insert_char

#
Editor::insert_completion

#
Editor::insert_text

#
Editor::is_selected

#
Editor::join_lines

#
Editor::lower_selection

#
Editor::match_bracket

#
Editor::move_down

#
Editor::move_file_end

#
Editor::move_file_start

#
Editor::move_left

#
Editor::move_line_end

#
Editor::move_line_first_non_whitespace

#
Editor::move_line_start

#
Editor::move_next_long_word

#
Editor::move_next_long_word_end

#
Editor::move_next_word

#
Editor::move_next_word_end

#
Editor::move_paragraph_next

#
Editor::move_paragraph_prev

#
Editor::move_prev_long_word

#
Editor::move_prev_word

#
Editor::move_right

#
Editor::move_to_column

#
Editor::move_up

#
Editor::open_above

#
Editor::open_below

#
Editor::paste_after

#
Editor::paste_before

#
Editor::redo

#
Editor::render

#
Editor::replace_range

#
Editor::replace_selection_with_char

#
Editor::replace_surround

#
Editor::replace_with_yanked

#
Editor::save

#
Editor::save_as

#
Editor::search_backward

#
Editor::search_forward

#
Editor::search_word_under_cursor

#
Editor::select_all

#
Editor::select_line

#
Editor::select_textobject

#
Editor::selected_text

#
Editor::selection_bounds