spellcheck-technical-word

spellcheck a text by using technical-word-rules.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
spellcheck-technical-word
402.0.08 years ago9 years agoMinified + gzip package size for spellcheck-technical-word in KB

Readme

spellcheck-technical-word Build Status
This library provide check function of azu/technical-word-rules.

Installation

npm install spellcheck-technical-word

Usage

var spellcheck = require("spellcheck-technical-word").spellCheckText;
var results = spellcheck("git");
assert(results.length > 0);
var result = results.pop();
/*
{ actual: 'git', expected: 'Git', paddingLine: 0, paddingColumn:0 }
*/

Result data structure
/**
 *
 * @typedef {{actual: string, expected: string, paddingLine: number, paddingColumn: number}} SpellCheckResult
 */
var result = {
    actual: "string",
    expected: "string",
    paddingLine: 0,// start with 0
    paddingColumn: 0// start with 0
};

Use case: azu/textlint-rule-helper

Tests

npm test

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT