#editor #highlighting #search

app ferro

A lightweight text editor written in Rust

2 unstable releases

0.6.0 Mar 11, 2023
0.5.0 Mar 8, 2023

#352 in Text editors

MIT license

110KB
2.5K SLoC

Ferro

Run ferro tests and coverage codecov

A lightweight text editor built in Rust.

Based on Philipp Flenker's Rust text editor tutorial.

Features

  • vim-like navigation controls
  • Syntax highlighting for Rust, Java, and Python (with more languages coming soon)
  • Incremental forward and backward search
  • Search-and-delete / search-and-replace
  • Auto-indentation
  • Built-in calculator for math expressions

Documentation

API documentation is located here.

For reference on controls and usage, see docs/usage.md.

If you're interested in contributing, check out CONTRIBUTING.md.

Installation

Using cargo

The simplest way to install ferro is to run cargo install ferro on your machine. You can then run ferro [file] to start editing!

From source

The following instructions assume that you've already installed Rust.

git clone https://github.com/alexxyu/ferro
cd ferro
cargo build --release

This will generate the binary for ferro in the target/release directory.

Dependencies

~9–19MB
~266K SLoC