spellcheck

Documentation

Overview

MIT License

Copyright (c) 2024 Travis Montoya

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func ExecSpellchecker(channel Channels)
• func LevDistance(word string, dictWord string) float64
• type Channels
• type Dict
  • func (d *Dict) CheckWord(word string) ([]string, error)
  • func (d *Dict) LoadFromFile(name string) error
  • func (d *Dict) LoadWordlist(r io.Reader) error

Functions

func ExecSpellchecker

func ExecSpellchecker(channel Channels)

Go routine to handle spellchecking Dictionary is hardcoded for now until we get config working

func LevDistance

func LevDistance(word string, dictWord string) float64

A mediocre Levenshtein Distance algorithm https://en.wikipedia.org/wiki/Levenshtein_distance

Types

type Channels

type Channels struct {
	ShouldSpellcheck bool
	CheckMin         int // CheckMin is the minimum amount of characters a line can have before it spell checks
	Spelling         chan []string
	Spellres         chan []string
	Done             chan string
}

type Dict

type Dict struct {
	MaxSuggest int
	// contains filtered or unexported fields
}

Dict holds information regarding the dictionary we have loaded and some behavioral settings such as MaxSuggest which limits the amount of suggestions we can receive back from CheckWord

MaxSuggest is the maximum suggestions to return for each word spelled wrong

func (*Dict) CheckWord

func (d *Dict) CheckWord(word string) ([]string, error)

func (*Dict) LoadFromFile

func (d *Dict) LoadFromFile(name string) error

func (*Dict) LoadWordlist

func (d *Dict) LoadWordlist(r io.Reader) error