misspell

Documentation

Index

• Variables
• func CaseVariations(word string, style WordCase) []string
• func ReadTextFile(filename string) (string, error)
• func RemoveEmail(s string) string
• func RemoveHost(s string) string
• func RemoveNotWords(s string) string
• func RemovePath(s string) string
• func StripURL(s string) string
• type Diff
• type Replacer
  • func New() *Replacer
  • func (r *Replacer) AddRuleList(additions []string)
  • func (r *Replacer) Compile()
  • func (r *Replacer) RemoveRule(ignore []string)
  • func (r *Replacer) Replace(input string) (string, []Diff)
  • func (r *Replacer) ReplaceReader(raw io.Reader, w io.Writer, next func(Diff)) error
• type WordCase
  • func CaseStyle(word string) WordCase

Variables

var DictAmerican = []string{}/* 9720 elements not displayed */

DictAmerican converts UK spellings to US spellings

var DictBritish = []string{}/* 8870 elements not displayed */

DictBritish converts US spellings to UK spellings

var DictMain = []string{}/* 168044 elements not displayed */

DictMain is the main rule set, not including locale-specific spellings

Functions

func CaseVariations

func CaseVariations(word string, style WordCase) []string

CaseVariations returns If AllUpper or First-Letter-Only is upcased: add the all upper case version If AllLower, add the original, the title and upcase forms If Mixed, return the original, and the all upcase form

func ReadTextFile

func ReadTextFile(filename string) (string, error)

ReadTextFile returns the contents of a file, first testing if it is a text file

returns ("", nil) if not a text file
returns ("", error) if error
returns (string, nil) if text

unfortunately, in worse case, this does

 1 stat
 1 open,read,close of 512 bytes
 1 more stat,open, read everything, close (via ioutil.ReadAll)
This could be kinder to the filesystem.

This uses some heuristics of the file's extension (e.g. .zip, .txt) and uses a sniffer to determine if the file is text or not. Using file extensions isn't great, but probably good enough for real-world use. Golang's built in sniffer is problematic for differnet reasons. It's optimized for HTML, and is very limited in detection. It would be good to explicitly add some tests for ELF/DWARF formats to make sure we never corrupt binary files.

func RemoveEmail

func RemoveEmail(s string) string

RemoveEmail remove email-like strings, e.g. "nickg+junk@xfoobar.com", "nickg@xyz.abc123.biz"

func RemoveHost

func RemoveHost(s string) string

RemoveHost removes host-like strings "foobar.com" "abc123.fo1231.biz"

func RemoveNotWords

func RemoveNotWords(s string) string

RemoveNotWords blanks out all the not words

func RemovePath

func RemovePath(s string) string

RemovePath attempts to strip away embedded file system paths, e.g.

/foo/bar or /static/myimg.png

TODO: windows style

func StripURL

func StripURL(s string) string

StripURL attemps to replace URLs with blank spaces, e.g.

"xxx http://foo.com/ yyy -> "xxx          yyyy"

Types

type Diff

type Diff struct {
	Filename  string
	FullLine  string
	Line      int
	Column    int
	Original  string
	Corrected string
}

Diff is datastructure showing what changed in a single line

type Replacer

type Replacer struct {
	Replacements []string
	Debug        bool
	// contains filtered or unexported fields
}

Replacer is the main struct for spelling correction

func New

func New() *Replacer

New creates a new default Replacer using the main rule list

func (*Replacer) AddRuleList

func (r *Replacer) AddRuleList(additions []string)

AddRuleList appends new rules. Input is in the same form as Strings.Replacer: [ old1, new1, old2, new2, ....] Note: does not check for duplictes

func (*Replacer) Compile

func (r *Replacer) Compile()

Compile compiles the rules. Required before using the Replace functions

func (*Replacer) RemoveRule

func (r *Replacer) RemoveRule(ignore []string)

RemoveRule deletes existings rules. TODO: make inplace to save memory

func (*Replacer) Replace

func (r *Replacer) Replace(input string) (string, []Diff)

Replace is corrects misspellings in input, returning corrected version

along with a list of diffs.

func (*Replacer) ReplaceReader

func (r *Replacer) ReplaceReader(raw io.Reader, w io.Writer, next func(Diff)) error

ReplaceReader applies spelling corrections to a reader stream. Diffs are emitted through a callback.

type WordCase

type WordCase int

WordCase is an enum of various word casing styles

const (
	AllLower WordCase = iota
	AllUpper
	Title
	Mixed
	Camel
)

Various WordCase types.. likely to be not correct

func CaseStyle

func CaseStyle(word string) WordCase

CaseStyle returns what case style a word is in