feat(main): implement spellcheck

Author: isuke

README.md

@@ -16,8 +16,7 @@ $ npm install -g git-consistent
 # or
 $ yarn global add git-consistent
 
-# options
-$ git config --global alias.con "consistent -i"
+$ git config --global alias.con "consistent -i -t" # recommended option
 ```
 
 ## Usage
@@ -74,11 +73,7 @@ $ git-consistent --help
     --type <type>            commit type
     -m, --subject <subject>  The subject contains succinct description of the change
     --body [body]            The body contains details of the change (default: )
-    -d, --duet               run git-duet mode
-    -D, --dry-run            run dry-run mode
-    -i, --interactive        run interactive mode
-    -s, --skip-options       skip not required term input (interactive mode only)
-    -S, --silent             don't show commit command
+    ...
     -V, --version            output the version number
     -h, --help               output usage information
 ```
@@ -200,6 +195,16 @@ Date:   Sat Feb 10 17:40:33 2018 +0900
     This is test.
 ```
 
+#### spell check
+
+With `-t` option.
+
+```sh
+$ git consistent -t --type="feat" --scope="" --subject="this is some text we want to ceck for typos"
+git commit -m "feat: this is some text we want to ceck for typos"
+Is 'ceck' misspelled? Did you mean that? 'check', 'ceca', 'neck', 'cock', 'deck', 'peck', 'heck', 'beck', 'Peck', 'Beck', 'Keck'
+```
+
 #### git-duet
 
 Run [git-duet](https://github.com/git-duet/git-duet) mode when with `-d` option.
@@ -253,23 +258,22 @@ Date:   Sat Feb 10 15:13:40 2018 +0900
 
 ## command options
 
-| Option               | Default | Description                                          |
-|----------------------|---------|------------------------------------------------------|
-| `-d, --duet`         | false   | run git-duet mode                                    |
-| `-D, --dry-run`      | false   | run dry-run mode                                     |
-| `-i, --interactive`  | false   | run interactive mode                                 |
-| `-s, --skip-options` | false   | skip not required term input (interactive mode only) |
-| `-S, --silent`       | false   | dont show commit command                             |
-| `-V, --version`      |         | output the version number                            |
+| Option               | Description                                          |
+|----------------------|------------------------------------------------------|
+| `-d, --duet`         | run git-duet mode                                    |
+| `-D, --dry-run`      | run dry-run mode                                     |
+| `-i, --interactive`  | run interactive mode                                 |
+| `-s, --skip-options` | skip not required term input (interactive mode only) |
+| `-S, --silent`       | dont show commit command                             |
+| `-t, --typo-check`,  | check spell                                          |
+| `-V, --version`      | output the version number                            |
 
 ---
 
 # TODO
 ## feature
 ### support emoji
 
-### typo check
-
 ## Develop
 ### test
 

git-consistent

@@ -1,12 +1,14 @@
 #!/usr/bin/env node
 
-const path      = require('path')
-const fs        = require('fs')
-const _         = require('lodash')
-const yaml      = require('js-yaml')
-const execSync  = require('child_process').execSync
-const program   = require('commander')
-const prompt    = require('prompt-sync')()
+const path       = require('path')
+const fs         = require('fs')
+const _          = require('lodash')
+const yaml       = require('js-yaml')
+const execSync   = require('child_process').execSync
+const program    = require('commander')
+const prompt     = require('prompt-sync')()
+const spellcheck = require('nodehun-sentences');
+const nodehun    = require('nodehun');
 
 const templateFileName    = '.gitcommit_template'
 const definitionsFileName = '.git_consistent'
@@ -55,6 +57,7 @@ const createProgram = (program, definitions, terms) => {
     .option(`-i, --interactive`, 'run interactive mode')
     .option(`-s, --skip-options`, 'skip not required term input (interactive mode only)')
     .option(`-S, --silent`, "don't show commit command")
+    .option(`-t, --typo-check`, "check spell")
     .version(version)
     .parse(process.argv)
 }
@@ -197,6 +200,23 @@ const replaceTerm = (program, template, definition, term) => {
   return _.replace(template, `<${term}>`, decoratedValue)
 }
 
+const checkSpell = (message) => {
+  const dictionaryBase = path.dirname(require.resolve('dictionary-en-us'))
+  const hunspell = new nodehun(
+    fs.readFileSync(path.join(dictionaryBase, 'index.aff')),
+    fs.readFileSync(path.join(dictionaryBase, 'index.dic'))
+  )
+
+  spellcheck(hunspell, message, (e, typos) => {
+    if (e) throw e
+
+    _.forEach(typos, (typo) => {
+      process.stdout.write(`${yellow}Is '${typo.word}' misspelled? ${reset}`)
+      console.log(`${yellow}Did you mean that? ${typo.suggestions.map((s) => {return `'${s}'`}).join(', ')}${reset}`)
+    })
+  })
+}
+
 const checkAddedFile = () => {
   const addedFiles = execSync(`git diff --name-only --cached 2> /dev/null`).toString().trim()
   if (_.isEmpty(addedFiles)) throw new Error(`no changes added to commit.`)
@@ -222,10 +242,12 @@ const gitCommit = (commitMessage, duet = false, silent = false, dryRun = false)
 }
 
 const main = (program, template, definitions, terms) => {
-  checkAddedFile()
+  if (!program.dryRun) checkAddedFile()
 
   const commitMessage = replaceTerms(program, template, definitions, terms)
 
+  if (program.typoCheck) checkSpell(commitMessage)
+
   gitCommit(commitMessage.trim(), program.duet, program.silent, program.dryRun)
 }
 

package.json

@@ -20,8 +20,11 @@
   },
   "dependencies": {
     "commander": "^2.14.1",
+    "dictionary-en-us": "^2.0.0",
     "js-yaml": "^3.10.0",
     "lodash": "^4.17.5",
+    "nodehun": "^2.0.11",
+    "nodehun-sentences": "^1.0.4",
     "prompt-sync": "^4.1.5"
   }
 }

yarn.lock

@@ -8,29 +8,70 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
+array-unique@^0.1.1:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/array-unique/-/array-unique-0.1.1.tgz#b2dc8ec765d306537d7291e0e621e849d2573cf9"
+
+async@^2.1.4:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/async/-/async-2.6.0.tgz#61a29abb6fcc026fea77e56d1c6ec53a795951f4"
+  dependencies:
+    lodash "^4.14.0"
+
 commander@^2.14.1:
   version "2.14.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.14.1.tgz#2235123e37af8ca3c65df45b026dbd357b01b9aa"
 
+dictionary-en-us@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/dictionary-en-us/-/dictionary-en-us-2.0.0.tgz#b9135f403444bb5e4b3cf465fb7d3f2fd276a839"
+
 esprima@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.0.tgz#4499eddcd1110e0b218bacf2fa7f7f59f55ca804"
 
+in-publish@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/in-publish/-/in-publish-2.0.0.tgz#e20ff5e3a2afc2690320b6dc552682a9c7fadf51"
+
 js-yaml@^3.10.0:
   version "3.10.0"
   resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.10.0.tgz#2e78441646bd4682e963f22b6e92823c309c62dc"
   dependencies:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
-lodash@^4.17.5:
+lodash@^4.14.0, lodash@^4.17.5:
   version "4.17.5"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
 
+nodehun-sentences@^1.0.4:
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/nodehun-sentences/-/nodehun-sentences-1.0.4.tgz#a4aef2d7707d7d568133806e957a6a4ab9eb9106"
+  dependencies:
+    async "^2.1.4"
+    in-publish "^2.0.0"
+    partial "^0.0.3"
+    unique-words "^1.0.0"
+
+nodehun@^2.0.11:
+  version "2.0.11"
+  resolved "https://registry.yarnpkg.com/nodehun/-/nodehun-2.0.11.tgz#cbba5595720f325fb247fb0e7e2018a56f7ed188"
+
+partial@^0.0.3:
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/partial/-/partial-0.0.3.tgz#2d107bed98fcea8d28d7665495b39e61dfcd18c6"
+
 prompt-sync@^4.1.5:
   version "4.1.5"
   resolved "https://registry.yarnpkg.com/prompt-sync/-/prompt-sync-4.1.5.tgz#709ac182388b0e9a4a45b5683ed0449ed19f3eb8"
 
 sprintf-js@~1.0.2:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"
+
+unique-words@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/unique-words/-/unique-words-1.0.0.tgz#40b26a19f98061663c813cd97a1a20a7f8b55990"
+  dependencies:
+    array-unique "^0.1.1"