Navigation Menu

Skip to content

azu/spellcheck-technical-word

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

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

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published