Didyoumean

<h1 align="center">DidYouMean</h1> <p align="center"> <a href="LICENSE"><img src="https://img.shields.io/badge/license-GPL3-13233a?style=for-the-badge" /></a> <a href="https://github.com/hisbaan/didyoumean/actions"><img src="https://img.shields.io/github/workflow/status/hisbaan/didyoumean/tests?style=for-the-badge" /></a> <a href="https://aur.archlinux.org/packages/didyoumean/"> <img src="https://img.shields.io/aur/version/didyoumean?color=1793d1&label=AUR&logo=arch-linux&style=for-the-badge" /></a> <a href="https://aur.archlinux.org/packages/didyoumean-bin/"> <img src="https://img.shields.io/aur/version/didyoumean-bin?color=1793d1&label=AUR-bin&logo=arch-linux&style=for-the-badge" /></a> <a href="https://github.com/NixOS/nixpkgs/tree/master/pkgs/tools/misc/didyoumean"><img src="https://img.shields.io/badge/dynamic/json?color=5277c3&label=NixOS&query=%24.name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fhisbaan%2Fdidyoumean%2Freleases%2Flatest&style=for-the-badge&logo=NixOS"/></a> <a href="https://github.com/hisbaan/homebrew-tap"><img src="https://img.shields.io/badge/dynamic/json?color=fbb040&label=Homebrew&query=%24.name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fhisbaan%2Fdidyoumean%2Freleases%2Flatest&style=for-the-badge&logo=Homebrew" /></a> <a href="https://lib.rs/crates/didyoumean"> <img src="https://img.shields.io/crates/v/didyoumean?color=red&label=crates.io/lib.rs&logo=Rust&style=for-the-badge&logoColor=red" /></a> </p>

DidYouMean (or dym) is a command-line spelling corrector written in rust utilizing a simplified version of Damerau-Levenshtein distance. DidYouMean is for those moments when you know what a word sounds like, but you're not quite sure how it's spelled.

<p align="center"> <img src="img/cyclophosphamide.png" height="250" style="border-radius: 10px; margin: 0.5em;"/> </p>

Installation

Arch Linux (and derivatives)

DidYouMean is available on the AUR as three different packages:

• didyoumean: Last stable release, built from source (Thank you orhun!).
• didyoumean-git: Last git commit, built from source. This is the most up to date, but the least stable.
• didyoumean-bin: Last stable release, distributed as a binary. This is only available for x86_64 at the moment.

You can install it using any AUR helper. Using paru, the command would be as follows:

paru -S <package choice from above>

Homebrew (macOS)

Homebrew is a package manager for macOS. Currently, I have only packaged an x86_64 binary. The command to install it is as follows:

brew tap hisbaan/tap
brew install didyoumean

NixOS

evanjs very kindly packaged didyoumean for NixOS. The command to install is as follows:

nix-env install -iA nixpkgs.didyoumean

Cargo

Run the following command to build dym from source and install it in your home directory. Ensure that you have $CARGO_HOME/bin/ in your path.

cargo install didyoumean

Developer Installation

The build dependencies for this project are git, rust, rustc, and cargo. First, clone this repository, then run

cargo run -- <args>

where <args> are the command-line arguments you would pass the DidYouMean binary. Note that this is an unoptimized build contianing debug information so it runs much, much slower.