README.md

AutoCorrect for Node.js

The Native Node.js version of AutoCorrect built on NAPI.RS.

• Rust - autocorrect
• Ruby - autocorrect-rb
• Go - autocorrect-go
• Python - autocorrect-py
• Node.js - autocorrect-node
• JavaScript (Browser) - autocorrect-wasm
• Java - autocorrect-java

Installation

$ yarn add autocorrect-node

Use CLI

$ yarn autocorrect -h

Lint you files

$ yarn autocorrect --lint .

Work with Lint-Staged

If you are use lint-staged, you can add this config to your package.json for run AutoCorrect lint before commit for changed files.

{
  "lint-staged": {
    "*": [
      "autocorrect --lint"
    ]
  }
}

Usage

const autocorrect = require('autocorrect-node');

const out = autocorrect.format('Hello你好.');
console.log(out);
// Hello 你好。

out = autocorrect.formatFor("let title = 'Hello你好。'", 'js');
// let title = 'Hello 你好。'

const result = autocorrect.lintFor("let title = 'Hello你好。'", 'js');
console.log(result);
// {
//   filepath: 'js',
//   lines: [
//     { l: 1, c: 13, new: "'Hello 你好。'", old: "'Hello你好。'", severity: 1 }
//   ],
//   error: ''
// }

// Load Config
const configStr = JSON.stringify({ textRules: { 你好hello: 0 } });
autocorrect.loadConfig(configStr);
out = autocorrect.format('Hello你好.');
console.log(out);
// Hello 你好。
out = autocorrect.format('你好hello');
console.log(out);
// 你好hello

// Ignorer, if /path/to/workdir contains .autocorrectignore or .gitignore
const ignorer = new autocorrect.Ignorer('/path/to/workdir');
ignorer.isIgnored('README.md');