textlint-tester
- Version 14.8.1
- Published
- 74.3 kB
- 4 dependencies
- MIT license
Install
npm i textlint-tester
yarn add textlint-tester
pnpm add textlint-tester
Overview
testing tool for textlint rule.
Index
Classes
class TextLintTester
class TextLintTester {}
constructor
constructor();
method run
run: ( name: string, testRuleDefinition: TextlintRuleModule | TestConfig, { valid, invalid }: { valid?: TesterValid[]; invalid?: TesterInvalid[] }) => void;
run test for textlint rule.
Parameter name
name is name of the test or rule
Parameter testRuleDefinition
param is TextlintRuleCreator or TestConfig
Parameter valid
Parameter invalid
method testInvalidPattern
testInvalidPattern: ( testName: string, param: TextlintRuleModule | TestConfig, invalid: TesterInvalid) => void;
method testValidPattern
testValidPattern: ( testName: string, param: TextlintRuleModule | TestConfig, valid: TesterValid) => void;
Package Files (2)
Dependencies (4)
Dev Dependencies (11)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/textlint-tester
.
- Markdown[](https://www.jsdocs.io/package/textlint-tester)
- HTML<a href="https://www.jsdocs.io/package/textlint-tester"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3799 ms. - Missing or incorrect documentation? Open an issue for this package.