Package Exports
- @textlint/ast-tester
- @textlint/ast-tester/lib/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@textlint/ast-tester) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@textlint/ast-tester
Compliance tests for textlint's AST(Abstract Syntax Tree).
It check compliance of AST at minimum.
If you have created Processor plugin for textlint, you can use it for testing the plugin.
Installation
npm install -D @textlint/ast-testerUsage
test(textlintAST): void
if the AST is invalid, then throw Error
isTxtAST(textlintAST): boolean
if the AST is valid, then return true.
import {test, isTxtAST} from "@textlint/ast-tester";
import yourParse from "your-parser";
// recommenced: test much pattern test
const AST = yourParse("This is text");
test(AST);// if the AST is invalid, then throw Error
isTxtAST(AST);// true or falseTests
npm testContributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
License
MIT