chore: start codespell dictionary file in the root of the project (#1087)

codespell works by having a dictionary of pairs of malformed words and
their correct equivalents. This means that codespell will not catch most
issues out of the box, but we can train it based on the common spelling
issues we encounter along the way.

The plan is to add a pair to `dictionary` every time we encounter a typo
during a code review, and we ensure that error will not happen again
anymore.

See: https://github.com/resin-io/etcher/pull/1084
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
This commit is contained in:
Juan Cruz Viotti 2017-02-23 14:56:43 -04:00 committed by GitHub
parent 96a9b65ea7
commit 0db335c8f1
2 changed files with 2 additions and 1 deletions

1
dictionary Normal file
View File

@ -0,0 +1 @@
boolen->boolean

View File

@ -16,7 +16,7 @@
"jslint": "eslint lib tests scripts bin versionist.conf.js", "jslint": "eslint lib tests scripts bin versionist.conf.js",
"scsslint": "scss-lint lib/gui/scss", "scsslint": "scss-lint lib/gui/scss",
"htmllint": "node scripts/html-lint.js", "htmllint": "node scripts/html-lint.js",
"codespell": "codespell.py lib tests", "codespell": "codespell.py --dictionary=- --dictionary=dictionary lib tests",
"lint": "npm run jslint && npm run scsslint && npm run codespell && npm run htmllint", "lint": "npm run jslint && npm run scsslint && npm run codespell && npm run htmllint",
"changelog": "versionist", "changelog": "versionist",
"start": "electron lib/start.js", "start": "electron lib/start.js",