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

1$ yarn add autocorrect-node

Use CLI

1$ yarn autocorrect -h

Lint you files

1$ 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.

1{
2  "lint-staged": {
3    "*": [
4      "autocorrect --lint"
5    ]
6  }
7}

Usage

1const autocorrect = require('autocorrect-node');
2
3const out = autocorrect.format('Hello你好.');
4console.log(out);
5// Hello 你好。
6
7out = autocorrect.formatFor("let title = 'Hello你好。'", 'js');
8// let title = 'Hello 你好。'
9
10const result = autocorrect.lintFor("let title = 'Hello你好。'", 'js');
11console.log(result);
12// {
13//   filepath: 'js',
14//   lines: [
15//     { l: 1, c: 13, new: "'Hello 你好。'", old: "'Hello你好。'", severity: 1 }
16//   ],
17//   error: ''
18// }
19
20// Load Config
21const configStr = JSON.stringify({ textRules: { 你好hello: 0 } });
22autocorrect.loadConfig(configStr);
23out = autocorrect.format('Hello你好.');
24console.log(out);
25// Hello 你好。
26out = autocorrect.format('你好hello');
27console.log(out);
28// 你好hello
29
30// Ignorer, if /path/to/workdir contains .autocorrectignore or .gitignore
31const ignorer = new autocorrect.Ignorer('/path/to/workdir');
32ignorer.isIgnored('README.md');