Home Reference Source Repository 
import RuleManager from 'textlint/src/rule/rule-manager.js'
public class | source

RuleManager

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
Defined all rules in this object.

Method Summary

Public Methods
public

defineRule(ruleKey: string, ruleHandler: *)

public
public
public

getRule(ruleKey: *): *

public

importPlugin(pluginRules: Object, pluginName: String): void

Registers all given rules of a plugin.
public

isDefinedRule(ruleKey: *): *

public
public

Public Constructors

public constructor source

Public Members

public rules: RulesObject source

Defined all rules in this object.

Public Methods

public defineRule(ruleKey: string, ruleHandler: *) source

Params:

NameTypeAttributeDescription
ruleKey string
ruleHandler *

public getAllRuleNames(): * source

Return:

*

public getAllRules(): RulesObject source

Return:

RulesObject

public getRule(ruleKey: *): * source

Params:

NameTypeAttributeDescription
ruleKey *

Return:

*

public importPlugin(pluginRules: Object, pluginName: String): void source

Registers all given rules of a plugin.

Params:

NameTypeAttributeDescription
pluginRules Object

A key/value map of rule definitions.
pluginName String

The name of the plugin without prefix (textlint-plugin-).

Return:

void

public isDefinedRule(ruleKey: *): * source

Params:

NameTypeAttributeDescription
ruleKey *

Return:

*

public loadRules(ruleDir: string): RulesObject source

Params:

NameTypeAttributeDescription
ruleDir string

ruleDir is rule directory.

Return:

RulesObject

public resetRules() source