hisbaan / didyoumean

A CLI spelling corrector for when you're unsure

Hi! I'm Hisbaan

I'm a computer science student at the University of Toronto who is passionate about Linux and open source development. I like working on my dotfiles in my spare time and making my setup look pretty and more functional all at the same time :) Welcome to my hub, check out my dotfiles and and my other projects down below.

didyoumean's Issues

Child process created for clipboard terminates immediately (Hyprland)

As the title describes, the child process created to keep the clipboard from being cleared on X11/Wayland does not terminate when the clipboard changes on sway. On Hyprland (still in early development), it terminates right away. Not that sway is using wlroots and Hyprland is using wlroots-git. This is likely an issue with the clipboard being read and thus is likely not within the scope of this project, but instead in the cli-clipboard dependency.

Word Fail

So I saw this, fought with my package manager (cue Karen joke fighting with the manager) to get it installed, first test fails.

So if it's not obvious I'm 12 (at hart <-- see what I did there?) I tested the with the word "fert." The expectation was the top match should be fart but fart is no where to be seen...or smelt...(again see what I did there? I've got a million of them I tellz ya!) Swing and a miss. Then I tried "hart", again expecting heart, swing and a miss. If it wasn't obvious "smelt" also failed to suggest smelled.

Is there a way to improve matching? So far it's failed every test word but one.

Consider a different exit code and message when the input is spelled correctly

I would really appreciate a different exit code when my input word is spelled correctly vs when it is not.

Additionally, I would like to see a different message noting that my input was spelled correctly. Sometimes (when I forget to specify -v), I have to take a moment to double check if the first result is different from my input word.

$ dym supercalifragilisticexpialidocious # correct spelling
supercalifragilisticexpialidocious is spelled correctly
$ echo $?
0

$ dym supercalifragilisticexpialidociouX # last char typo
Did you mean?
1. supercalifragilisticexpialidocious
2. supercalifragilistic
3. superphlogistication
4. superartificiality
5. supercapabilities
$ echo $?
1

Regardless, thanks for your work on dym. It is very helpful as is!

Add shell completion

Add shell completion for bash, zsh, fish, and maybe PowerShell if it's not too hard.

Add manpages

Add manpages. Maybe duplicate the same manpage as dym and didyoumean

It would be nice if I could copy the correct word into my clipboard after selecting the number of that word

for example:

❯ dym tomrrow
Did you mean?
1. tomorrow
2. borrow
3. morrow
4. orrow
5. sorrow

I want it to be like

❯ dym tomrrow -y
Did you mean?
1. tomorrow
2. borrow
3. morrow
4. orrow
5. sorrow

Which word should be copied: 1
"tomorrow" has been copied to your clipboard.

-y flag stands for yanking the text to clipboard

Add tests

There is a distinct lack of tests in this project that I would like to address.

No language file for Northern Sámi

The ISO 639-2 code for this one is sme.

It would be great if we could add a wordlist for this language

Incorrect encoding on some language files

Some language files have encoding problems. I'm aware of the problem affecting Russian, Bosnian and possibly Estonian.

I can probably have a closer look at some others in the coming week.

Hilight differences between the searched word and the resulting words (diff style)

As the title says (with an optional flag), show the differences between the queried and resulting words. Showing removals is not recommended as that would require some sort of thinner character which I don't think would look very nice. Showing additions and substitutions should be easy enough. Showing transpositions as two insertions may be simpler? I'm not quite sure how that would work, but it should be doable.