Giter Club home page Giter Club logo

nodehun-sentences's Introduction

nodehun-sentences

Version npmBuild StatusCoverage StatusCode Climate

nodehun is a great library for interacting with hunspell from node.js. It's fairly low-level, however, letting you check one word at a time. nodehun-sentences lets you easily check whole sentences or chunks of text for errors.

It asynchronously checks all the words and returns with a result array containing all the encountered typos. For each typo, you will also get an array of all the positions within the string where the typo was encountered, so you can easily visualize all errors.

Installation

$ npm install --save nodehun-sentences

Usage

var spellcheck = require('nodehun-sentences');
spellcheck(nodehunInstance, textToCheck, function(err, typos) {
    // NOTE: `err` does NOT contain whether typos was found -
    // it returns any actual *errors* (not being passed a
    // valid instance of nodehun, for instance)
    if (err) {
        throw err;
    }

    // `typos` is an array of all typos, each one an object containing:
    //   - `word`: the word which was concidered a typo (string)
    //   - `suggestions`: list of suggestions (array of strings)
    //   - `positions`: list of positions where the typo was found (array of objects)
    typos.forEach(function(typo) {
        console.log('"' + typo.word + '" is not a valid word');
        console.log('found ' + typo.positions.length + ' occurences')
    });

    // Each entry in `typo.positions` contains the following keys:
    //   - `from`: The start offset for the typo within the text (integer)
    //   - `to`: The end offset for the typo within the text (integer)
    //   - `length`: Word length (integer)
    textToCheck.substring(typo[0].from, typo[0].to) === typo[0].word;
});

Taken from examples/spellcheck.js:

var fs = require('fs');
var spellcheck = require('nodehun-sentences');
var nodehun = require('nodehun');
var hunspell = new nodehun(
    fs.readFileSync('path/to/dictionary.aff'),
    fs.readFileSync('path/to/dictionary.dic')
);

var text = 'This is some text we want to ceck for typos';

spellcheck(hunspell, text, function(err, typos) {
    if (err) {
        throw err;
    }

    console.log(typos);

    typos == [{
        word: 'ceck',
        suggestions: [
            'check',
            'neck',
            'deck',
            'peck'
            // ...
        ],
        positions: [{
            from: 29,
            to: 33,
            length: 4
        }]
    }];
});

License

MIT-licensed. See LICENSE.

nodehun-sentences's People

Contributors

rexxars avatar kdzwinel avatar chytanya avatar luddd3 avatar oladon avatar

Watchers

James Cloos avatar  avatar Marcus avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.