retext-textlint

retext-textlint

retext plugin to use textlint.

Installation

npm:

npm install retext-textlint

Usage

Install textlint plugins.

npm:

npm install textlint-plugin-jtf-style

• example/example.js

var retext = require('retext')
var japanese = require('retext-japanese')
var textlint = require('retext-textlint')
var compact = require('eslint/lib/formatters/compact')

var text = 'タイトル「ＡＢＣ」\n' +
    '\n' +
    '1 これは前段です。これは中段（２文の場合は後段という。）です。これは後段です。'

var options = {
  plugins: [
    'textlint-plugin-jtf-style'
  ]
}

retext().use(japanese).use(textlint, options).process(text, (err, file, doc) => {
  if (err) {
    console.log(err)
  }
  console.log('\n=== doc ===')
  console.log(doc)

  console.log('\n=== file ===')
  console.log(compact([file]))
})

/**
* === doc ===
* タイトル「ＡＢＣ」
* 
* 1 これは前段です。これは中段（２文の場合は後段という。）です。これは後段です。
* 
* 
* === file ===
* : line 1, col 5, Warning - "jtf-style/2.1.9.アルファベット" アルファベットは「半角」で表記します。
* : line 3, col 16, Warning - "jtf-style/2.1.8.算用数字" 算用数字は「半角」で表記します。
* 
* 2 problems
*/

• example/.textlintrc

{
  "plugins": [
    "jtf-style"
  ],
  "rules": {
    "jtf-style/4.1.1.句点(。)": false,
    "jtf-style/3.1.1.全角文字と半角文字の間": false
  }
}

API

retext.use(textlint, options)

Parameters

• textlint — This plugin.

• options (Object, optional)

  • plugins (Array.<string>) - textlint plugin name array.

Related

• textlint
• retext
• retext-japanese
• vfile

License

MIT