Class Rule

constructor

• new Rule(
      name: string | null | undefined,
      severity: number | null | undefined,
      selector: default | null | undefined,
      pattern: RegExp | null | undefined,
      lint: string | LintTester | undefined,
      applies: AppliesTester | undefined,
  ): Rule

  Parameters

  • name: string | null | undefined
  • severity: number | null | undefined
  • selector: default | null | undefined
  • pattern: RegExp | null | undefined
  • lint: string | LintTester | undefined
  • applies: AppliesTester | undefined

  Returns Rule

applies

lint

message

name

pattern

selector

severity

StaticDEFAULT_SELECTOR

StaticSeverity

_defaultLintFunction

• _defaultLintFunction(
      state: TraversalState,
      content: string,
      selectorMatch: readonly TreeNode[],
      patternMatch: any,
      context: LintRuleContextObject,
  ): { end: number; message: string; start: number }

  Parameters

  • state: TraversalState
  • content: string
  • selectorMatch: readonly TreeNode[]
  • patternMatch: any
  • context: LintRuleContextObject

  Returns { end: number; message: string; start: number }

check

• check(
      node: TreeNode,
      traversalState: TraversalState,
      content: string,
      context: LintRuleContextObject,
  ): RuleCheckReturnType

  Parameters

  • node: TreeNode
  • traversalState: TraversalState
  • content: string
  • context: LintRuleContextObject

  Returns RuleCheckReturnType

StaticFakePatternMatch

• FakePatternMatch(
      input: string,
      match: string | null | undefined,
      index: number,
  ): any

  Parameters

  • input: string
  • match: string | null | undefined
  • index: number

  Returns any

StaticmakePattern

• makePattern(pattern?: string | RegExp | null): RegExp | null | undefined

  Parameters

  • Optionalpattern: string | RegExp | null

  Returns RegExp | null | undefined

StaticmakeRule

• makeRule(options: MakeRuleOptions): Rule

  Parameters

  • options: MakeRuleOptions

  Returns Rule