validate

Documentation

Overview

Package validate contains wordlist validation rules.

Index

• func All(word string, currentWords []string) error
• func DuplicateWords(words []string) error
• func WordLength(word string) error
• func WordMinDistance(word string, words []string) error
• func WordPrefix(word string, allWords []string) error

Functions

func All

func All(word string, currentWords []string) error

All runs all validation checks on a word list.

func DuplicateWords

func DuplicateWords(words []string) error

DuplicateWords returns an error if the given word list contains any duplicates.

func WordLength

func WordLength(word string) error

WordLength returns an error if the given word is shorter than 3 characters or longer than 8 characters.

func WordMinDistance

func WordMinDistance(word string, words []string) error

WordMinDistance returns an error if the given word has a Damerau-Levenshtein distance of less than 2 from any other word in the word list.

func WordPrefix

func WordPrefix(word string, allWords []string) error

WordPrefix returns an error if the given word shares the same 4-character prefix as another word in the word list.