grunt-ganescha-spellcheck

grunt-ganescha-spellcheck

Spellcheck passed data

Getting Started

This plugin requires Grunt ~1.0.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as how to install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with the following command:

npm install grunt-ganescha-spellcheck --save-dev

Once the plugin has been installed, it can be enabled within your Gruntfile by adding the following line of JavaScript:

grunt.loadNpmTasks('grunt-ganescha-spellcheck');

The "spellcheck" task

Overview

In your project's Gruntfile, add a section named spellcheck to the data object passed into grunt.initConfig().

grunt.initConfig({
    spellcheck: {
        somethingToRecognizeMySpellcheck: {
            dict: {
                aff: 'node_modules/Ganescha-Spellcheck/lib/dict/en/en.aff',
                dic: 'node_modules/Ganescha-Spellcheck/lib/dict/en/en.dic'
            },
            langData: 'either/a/string/to/spellcheck/or/a/path/to/my/language/data/en.json'
        }
    }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Note:

The core lib (Ganescha-Spellcheck) is only accessible to members of Ganescha Labs, so this won't be of any use to you if you aren't a member.