Skip to content

Commit 8a19ec5

Browse files
author
Ed Page
committed
docs: Remove reference to misspell-rs
This project seems to be dead
1 parent 36131c2 commit 8a19ec5

File tree

3 files changed

+20
-99
lines changed

3 files changed

+20
-99
lines changed

‎benchsuite/benchsuite.sh

+2-14
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,6 @@ typos_path=`$current_dir/uut/typos.sh path $base_dir`
5757
typos_version=`$current_dir/uut/typos.sh version $base_dir`
5858
print_tool "typos" "$typos_version" "$typos_path" "$report_path"
5959

60-
misspell_rs_path=`$current_dir/uut/misspell_rs.sh path $base_dir`
61-
misspell_rs_version=`$current_dir/uut/misspell_rs.sh version $base_dir`
62-
print_tool "misspell_rs" "$misspell_rs_version" "$misspell_rs_path" "$report_path"
63-
6460
misspell_go_path=`$current_dir/uut/misspell_go.sh path $base_dir`
6561
misspell_go_version=`$current_dir/uut/misspell_go.sh version $base_dir`
6662
print_tool "misspell_go" "$misspell_go_version" "$misspell_go_path" "$report_path"
@@ -103,10 +99,6 @@ function bench_dir() {
10399
typos_ascii_command="$typos_path --no-unicode $path"
104100
typos_j1_command="$typos_path --threads 1 $path"
105101
fi
106-
misspell_rs_command=""
107-
if [[ ! -z $misspell_rs_path ]]; then
108-
misspell_rs_command="$misspell_rs_path $path"
109-
fi
110102
misspell_go_command=""
111103
if [[ ! -z $misspell_go_path ]]; then
112104
misspell_go_command="$misspell_go_path $path"
@@ -116,7 +108,7 @@ function bench_dir() {
116108
if [[ ! -z $codespell_path ]]; then
117109
codespell_command="$codespell_path $path"
118110
fi
119-
hyperfine --warmup 1 -i --export-json $report_prefix-rg.json --export-markdown $report_prefix-rg.md "$rg_command" "$rg_j1_command" "$typos_command" "$typos_ascii_command" "$typos_j1_command" "$misspell_rs_command" "$misspell_go_command" "$codespell_command"
111+
hyperfine --warmup 1 -i --export-json $report_prefix-rg.json --export-markdown $report_prefix-rg.md "$rg_command" "$rg_j1_command" "$typos_command" "$typos_ascii_command" "$typos_j1_command" "$misspell_go_command" "$codespell_command"
120112
cat $report_prefix-rg.md >> $output
121113
fi
122114
echo "" >> $output
@@ -146,10 +138,6 @@ function bench_file() {
146138
typos_command="$typos_path $path"
147139
typos_ascii_command="$typos_path --no-unicode $path"
148140
fi
149-
misspell_rs_command=""
150-
if [[ ! -z $misspell_rs_path ]]; then
151-
misspell_rs_command="$misspell_rs_path $path"
152-
fi
153141
misspell_go_command=""
154142
if [[ ! -z $misspell_go_path ]]; then
155143
misspell_go_command="$misspell_go_path $path"
@@ -162,7 +150,7 @@ function bench_file() {
162150
if [[ ! -z $codespell_path ]]; then
163151
codespell_command="$codespell_path $path"
164152
fi
165-
hyperfine --warmup 1 -i --export-json $report_prefix-rg.json --export-markdown $report_prefix-rg.md "$rg_command" "$typos_command" "$typos_ascii_command" "$misspell_rs_command" "$misspell_go_command" "$scspell_command" "$codespell_command"
153+
hyperfine --warmup 1 -i --export-json $report_prefix-rg.json --export-markdown $report_prefix-rg.md "$rg_command" "$typos_command" "$typos_ascii_command" "$misspell_go_command" "$scspell_command" "$codespell_command"
166154
cat $report_prefix-rg.md >> $output
167155
fi
168156
echo "" >> $output

‎benchsuite/uut/misspell_rs.sh

-66
This file was deleted.

‎docs/comparison.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
# Related Spell Checkers
22

3-
| | typos | [bloom42/misspell][misspell-rs] | [client9/misspell][misspell-go] | [codespell] | [scspell3k] |
4-
|----------------|-----------------------|---------------------------------|---------------------------------|-------------|-------------|
5-
| Runtime | \- | \- | \- | Python | Python |
6-
| [Approach](design.md) | Correction | Correction | Correction | Correction | Dictionary |
7-
| Custom Dict | Yes | No | ? | Yes | Yes |
8-
| Per-Lang Dict | Yes | No | ? | No | Yes |
9-
| CamelCase | Yes | No | ? | No | Yes |
10-
| snake_case | Yes | No | ? | No | Yes |
11-
| Ignore Hex | Yes | No | ? | No | Yes |
12-
| C-Escapes | No ([#20][def-3]) | No | ? | No | Yes |
13-
| Encodings | UTF-8 / UTF-16 | UTF-8 | ? | Auto | Auto |
14-
| Whole-project | Yes | Yes | Yes | Yes | No |
15-
| Ignores hidden | Yes | Yes | ? | Yes | No |
16-
| Respect gitignore | Yes | Yes | ? | No | No |
17-
| Checks filenames | Yes | No | ? | Yes | No |
18-
| Status via exit code | Yes | No | Yes | Yes | Yes |
19-
| API | Rust / [JSON Lines] | Rust | ? | Python | None |
20-
| License | MIT or Apache | AGPL | MIT | GPLv2 | GPLv2 |
3+
| | typos | [client9/misspell][misspell-go] | [codespell] | [scspell3k] |
4+
|----------------|-----------------------|---------------------------------|-------------|-------------|
5+
| Runtime | \- | \- | Python | Python |
6+
| [Approach](design.md) | Correction | Correction | Correction | Dictionary |
7+
| Custom Dict | Yes | ? | Yes | Yes |
8+
| Per-Lang Dict | Yes | ? | No | Yes |
9+
| CamelCase | Yes | ? | No | Yes |
10+
| snake_case | Yes | ? | No | Yes |
11+
| Ignore Hex | Yes | ? | No | Yes |
12+
| C-Escapes | No ([#20][def-3]) | ? | No | Yes |
13+
| Encodings | UTF-8 / UTF-16 | ? | Auto | Auto |
14+
| Whole-project | Yes | Yes | Yes | No |
15+
| Ignores hidden | Yes | ? | Yes | No |
16+
| Respect gitignore | Yes | ? | No | No |
17+
| Checks filenames | Yes | ? | Yes | No |
18+
| Status via exit code | Yes | Yes | Yes | Yes |
19+
| API | Rust / [JSON Lines] | ? | Python | None |
20+
| License | MIT or Apache | MIT | GPLv2 | GPLv2 |
2121

2222
See also [benchmarks](../benchsuite/runs).
2323

2424
[JSON Lines]: http://jsonlines.org/
2525
[scspell3k]: https://github.com/myint/scspell
26-
[misspell-rs]: https://gitlab.com/bloom42/misspell
2726
[misspell-go]: https://github.com/client9/misspell
2827
[codespell]: https://github.com/codespell-project/codespell
2928
[def-9]: https://github.com/crate-ci/typos/issues/9

0 commit comments

Comments
 (0)