Kaolinite

A crate to assist in the creation of TUI text editors.

Key Features • How To Use • Credits • License

Key Features

• Buffers files to prevent hold ups when opening and saving your files
• Unicode safe - supports double width characters on the terminal
• Handles scrolling and cursor - No more janky cursor incrementing code
• Dynamically handles formatting of files - Determines style on read, keeps that style on write
  • Unix and DOS line endings
  • Tabs & Spaces
• Includes searching & replacing features
• Line number formatting utility
• File type recognition
• Advanced moving abilities (by page, words, characters)
• Includes undo & redo functionality
• Lightweight - very few dependencies for quick compilation of your editor
• Front-end agnostic - Feel free to use Crossterm or Termion or anything else!

How To Use

You'll need to have a modern Rust toolchain. Click here if you need that.

# If you already have a project set up, ignore this step
$ cargo new [app name]
$ cd [app name]

# Simplest way to add to your project is using cargo-edit
# You can also manually add it into your Cargo.toml if you wish
$ cargo install cargo-edit
$ cargo add kaolinite

# You should be ready to use the crate now!

If you require documentation, please consult https://docs.rs/kaolinite. You'll find detailed API explainations and examples.

Don't hesitate to contact me (see bottom of readme) if you require assistance.

Credits

This software uses the following open source crates:

• unicode-width
• regex
• ropey
• quick_error

License

MIT

Github @curlpipe  ·  Discord curlpipe#1496  ·  Crates.io curlpipe