Project Restructuring

[tgross35]

Now that we have some direction on how this project should look, we can do some serious restructuring

Basic module layout:

• main: re-export Config, Dictionary, DictBuilder
• dictionary: data structures needed to represent a dictionary
• affix: data structures to represent an affix file
• system: helpers for locating files
• check: functions for checking words with a dictionary
• suggestions: functions for suggesting words when checks fail
• meta (?): further information, e.g. [Discussion] More than checking if a word is in the dictionary #27

From #27:

struct Dictionary {
    config: Config,
    wordlist: HashSet<Entry>,
    wordlist_nosuggest: HashSet<Entry>,
    wordlist_forbidden: HashSet<Entry>
    meta: Vec<Weak<Meta>>
}

struct Entry {
    word: String,
    meta: Vec<Rc<Meta>>
}

struct Meta {
    // Any info relevant to that entry including homonyms & source
}

struct Config {
  // similar to current
}