Feature: Technical Dictionary

[benjam-es]

Discussion

We could introduce the concept of a technical dictionary into the project. Although we do have provide developers the ability to define their own words to ignore within the config file peck.json, I believe are many benefits to having a built in technical dictionary.

Proposal

• A new dictionary.json file
• Maintain a list of known obvious technical words that developers would expect to be correct
• Use this list along side ignore words to exclude words from ever being spell checked
• Possibly allow a way to override this functionality such as a config to turn it off, or publishing of the file for modification

Benefits

• Reduces friction to usage / adoption of the tool as spell check errors for known words such as http might be seen as unexpected
• Removed manual work for developers in having to maintain and update a list of ignore words that should already not be needed to be spell checked
• Improves performance
  • If we ensure words within the technical dictionary are totally excluded from the spell check to begin with, we use less resources in checking those words
  • This dictionary could also have some words within that would pass the spell check, therefore reducing the spell check run count for words that done need it.

[benjam-es]

To further expand this, we could introduce the concept of project dictionary.

• A project dictionary could be built up upon each scan, adding words which do pass the spell check
• The project dictionary would then allow the spell checker to skip words within this dictionary
• This could be automatic or could be via a command to optimize peck.
  • Adds all words that pass so when a method getTheSalesData is spell checked, we see get, the, sales and data are all valid words therefore we never need to spell check them in the future.
  • Further improving performance for following checks by not checking those words

[c0nst4ntin]

@benjam-es With the presets now merged, can this be closed? Or ist there Something else this would bring to the project?