Spellunker(3)

💅 Spellunker(3) — the perl spelling checker page, but make it a group chat

okay so bestie, welcome to Spellunker — Pure perl spelling checker implementation. Yes, that's the whole NAME line, and yes, she's pure perl. No cap. 🦋

✨ DESCRIPTION ✨

Spellunker is a pure perl spelling checker implementation. The big slay here is that you can use this spelling checker as a library — like, drop her right into your own code and she just works. 👑

And this distribution provides the spellunker and spellunker-pod commands. Two commands, both iconic, both doing their thing. 🎀

If you wanna use this spelling checker inside a test script, you can use Test::Spellunker. That's literally what it's for. iykyk. ⭐

---

🌸 METHODS 🌸

• my $spellunker = Spellunker->new(); — Create new instance. That's it, that's the vibe. Fresh spellunker, fresh start, main character energy. ✨
• $spellunker->load_dictionary($filename_or_fh) — Loads stopwords from $filename_or_fh and adds them to the on-memory dictionary. (fh = filehandle bestie, she takes both, she's flexible like that 💅)
• $spellunker->add_stopwords(@stopwords) — Add some @stopwords to the on memory dictionary. Just yeet those words in there. 🫶
• $spellunker->clear_stopwords(); — Crear the information of stop words. (That's the original wording, typo and all — clear out all the stop word info, she's starting over 😭)
• $spellunker->check_word($word); — Check the word looks good or not. One word, one vibe check. 🔥
• @bad_words = $spellunker->check_line($line) — Check the text and returns bad word list. She returns a list of the bad words, so you get the whole receipts, not just a yes/no. 💀

---

🧚 HOW DO I USE CUSTOM DICTIONARY? 🧚

You can put your personal dictionary at "$HOME/.spellunker.en". That's it. That's the path. Put your lil custom words there and she'll respect them. 🌈

---

💜 WHY DOES SPELLUNKER NOT IGNORE PERL CODE? 💜

In some case, Spellunker does not ignore the perl code. So like, sometimes she's gonna look at your actual perl code and go "hmm, that's a word?" 🙈

The fix: you need to wrap it by C< >. Wrap the code, save the vibe check.

---

🎀 CONTRIBUTION 🎀

You can send me pull-request on github. Go off, contribute, be the icon you wish to see in the world. 👑

---

📜 LICENSE 📜

Copyright (C) tokuhirom

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Read that again — free software, same terms as Perl itself, fr fr. 🍓

---

🌟 AUTHOR 🌟

tokuhirom <tokuhirom@gmail.com>

---

and that's the page bestie!! 🫶 this was perl v5.32.1, dated 2019-09-22, brought to you by User Contributed Perl Documentation — mwah, go spell some words 💖✨