Helix fork README

This repo is a fork of the project https://github.com/helix-editor/helix.

The goal is to refine and tweak the Helix code to fit my own needs. After verification and testing, changes will be proposed to the upstream repository.

Current progress and plans:

• Complete flexible modal/modeless layout support. The idea is to use Ctrl (switched with CapsLock) for both mode switch (on click) and commands in insert mode (while holding).
  • Add config setting editor.default-mode. (https://github.com/zheland/helix-fork/commit/49f7423eef16a3a4af96e2f40691c3d9a657cec9).
  • Handle modifier keys (KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES).
  • Handle key release events (KeyboardEnhancementFlags::REPORT_EVENT_TYPES).
  • Support "click" shortcuts that will trigger only if no other keys were pressed between press and release.
  • ...
• Support Local History (similar to Timeline feature from VSCode, or Local History from Sublime Text, IntelliJ IDEA and Eclipse).
• Highlight panicking functions like unwrap, expect and others ideally based on presence of Panics section in function or method docs.
• ...

Notes:

• Use cxt.editor.set_status(format!("{:?}", smth)); for easy debugging.

Upstream README

A Kakoune / Neovim inspired editor, written in Rust.

The editing model is very heavily based on Kakoune; during development I found myself agreeing with most of Kakoune's design decisions.

For more information, see the website or documentation.

All shortcuts/keymaps can be found in the documentation on the website.

Troubleshooting

Features

• Vim-like modal editing
• Multiple selections
• Built-in language server support
• Smart, incremental syntax highlighting and code editing via tree-sitter

Although it's primarily a terminal-based editor, I am interested in exploring a custom renderer (similar to Emacs) using wgpu or skulpin.

Note: Only certain languages have indentation definitions at the moment. Check runtime/queries/<lang>/ for indents.scm.

Installation

Installation documentation.

Contributing

Contributing guidelines can be found here.

Getting help

Your question might already be answered on the FAQ.

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).

Credits

Thanks to @jakenvac for designing the logo!