ryaspeller 0.1.3

A tool and lib for searching typos in text, files and websites
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# ryaspeller
[![Actions Status](https://github.com/oriontvv/ryaspeller/workflows/CI/badge.svg)](https://github.com/oriontvv/ryaspeller/actions)
[![dependency status](https://deps.rs/repo/github/oriontvv/ryaspeller/status.svg)](https://deps.rs/repo/github/oriontvv/ryaspeller)
[![Doc](https://docs.rs/ryaspeller/badge.svg)](https://docs.rs/ryaspeller)
[![Crates.io](https://img.shields.io/crates/v/ryaspeller.svg)](https://crates.io/crates/ryaspeller)


[ryaspeller](https://github.com/oriontvv/ryaspeller) (Rust Yandex Speller) is a tool and library for searching typos in text, files and websites.

Used [Yandex.Speller API](https://tech.yandex.ru/speller/doc/dg/concepts/About-docpage/). ([restrictions](<https://yandex.ru/legal/speller_api/>))

## Installation

```bash
cargo install ryaspeller
```

## Usage

 * binary:

```bash
$ ryaspeller "text_or_path_or_url"
$ ryaspeller russt --lang en
rust
$ ryaspeller ./doc --lang en,ru
$ ryaspeller https://team-tricky.github.io > page.html
```

 * library:
 ```rust
 use ryaspeller::{Config, Speller};

let speller = Speller::new(Config::default());
let spelled = speller.spell_text("Triky Custle is a funny puzzle game.").unwrap();
assert!(spelled == "Tricky Castle is a funny puzzle game.");
 ```

Also there are available [python](https://github.com/oriontvv/pyaspeller/) and [javascript](https://github.com/hcodes/yaspeller) versions of this speller.