textlint scripts help you to create textlint rule.
npm install textlint-scriptstextlint scripts help you to create textlint rule.
Documentation of creating a textlint rule:
Install with npm:
npm install textlint-scripts --save-dev
Use textlint-scripts as npm-scripts.
``json`
{
"scripts" : {
"build": "textlint-scripts build",
"test": "textlint-scripts test"
}
}
:memo: TypeScript
textlint-scripts support TypeScript.
textlint-scripts detect the project is TypeScript by tsconfig.json in project root directory.
Build source codes in src/ and output to lib/.
It is built by Babel with env preset.
Additionally, build command inline Node fs calls with babel-plugin-static-fs for browser compatibility. fs
(Web Browser does not support Node.js's module, this inlining feature improve compatibility between Node.js and Web Browser.)
:memo: Disable inlining by $ NO_INLINE=1 textlint-scripts build.
Test test codes in test/ by Mocha.
Usually test textlint rule using textlint-tester.
Notes: register script
textlint-scripts also provide register script for run-time build.
It will help to run tests from your IDE like WebStorm.
`js
mocha --require textlint-scripts/register "test/*/.js"ts
mocha --require textlint-scripts/register-ts "test/*/.ts"
See Releases page.
MIT © azu