test for insensitive wording using alex.js (hoodiehq#333)

Author: tsriram

README.md

@@ -134,6 +134,13 @@ The new hood.ie Website doesn't need to be deployed after making changes. (Only
     - run `bundle exec jekyll serve --watch --drafts` in your terminal and wait until it says `server running`
     - go to `localhost:4000/blog`. All currently available drafts are then just displayed as regular Blog posts. You can now check your draft and edit it in your editor. (Note: Jekyll is sometimes a bit slow, so this may take a little bit.)
 
+### Checking for insensitive content in the post
+* [Alex.js](http://alexjs.com/) is used to check for any insensitve content
+* When you want to check if the draft contains any insensitive content,
+    - run `npm run alex -- -f _posts/<your-post-filename>.md`
+    - look into reported issues and try to resolve them where it makes sense
+    - you can also do `npm run alex -- -d _drafts` to check for insensitive content in all posts inside _drafts folder
+
 ### Publishing the drafted Blog post
 
 From the command line –

bin/language-checker.js

@@ -0,0 +1,66 @@
+// Utility to run files through Alex.js (http://alexjs.com/)
+// run using `npm run alex`
+var fs = require('fs')
+var path = require('path')
+var toVFile = require('to-vfile')
+var argv = require('argv')
+var alex = require('alex')
+var colors = require('colors/safe')
+
+colors.setTheme({
+  info: 'green',
+  warn: 'yellow',
+  error: 'red'
+})
+
+var options = [
+  {
+    name: 'dir',
+    short: 'd',
+    type: 'path',
+    description: 'directory to run through Alex.js',
+    example: 'npm run alex -- -d _posts'
+  },
+  {
+    name: 'file',
+    short: 'f',
+    type: 'path',
+    description: 'file to run through Alex.js',
+    example: 'npm run alex -- -f _posts/2013-06-08-hacker-news-thread-about-hoodie.md'
+  }
+]
+
+var args = argv.option(options).run()
+
+if (args.options.dir) {
+  scanDir(args.options.dir)
+}
+
+if (args.options.file) {
+  scanFile(args.options.file)
+}
+
+function scanFile (file) {
+  try {
+    var vfile = toVFile.readSync(file)
+    var messages = alex.markdown(vfile).messages
+    if (messages.length) {
+      console.log(colors.warn(messages))
+    } else {
+      console.log(colors.info('alex.js says ' + file + ' looks good!'))
+    }
+  } catch (error) {
+    console.error(colors.error('Error in reading file ' + file + ' - ' + error.message))
+  }
+}
+
+function scanDir (dir) {
+  try {
+    var files = fs.readdirSync(dir)
+    files.forEach(function (file) {
+      scanFile(dir + path.sep + file)
+    })
+  } catch (error) {
+    console.log(colors.error('Error in reading directory ' + dir + ' - ' + error.message))
+  }
+}

package.json

@@ -3,9 +3,13 @@
   "version": "0.1.0",
   "scripts": {
     "start": "grunt",
-    "build": "grunt build"
+    "build": "grunt build",
+    "alex": "node ./bin/language-checker.js"
   },
   "devDependencies": {
+    "alex": "^4.0.1",
+    "argv": "0.0.2",
+    "colors": "^1.1.2",
     "grunt": "^0.4.5",
     "grunt-autoprefixer": "^1.0.1",
     "grunt-cli": "^0.1.13",
@@ -16,7 +20,8 @@
     "grunt-contrib-watch": "^0.6.1",
     "grunt-sass": "^1.0.0",
     "grunt-string-replace": "^1.0.0",
-    "time-grunt": "^1.0.0"
+    "time-grunt": "^1.0.0",
+    "to-vfile": "^2.1.1"
   },
   "frontend": {
     "name": "Hood.ie Sass/JS",