Interface IGrammarValidatorErrorMessageProvider

Implementing this interface enables customizing grammar validation errors when using custom APIs.

See detailed docs for Custom APIs

Hierarchy

IGrammarValidatorErrorMessageProvider

Index

Methods

Methods

buildAlternationAmbiguityError

buildAlternationAmbiguityError(options: { alternation: Alternation; ambiguityIndices: number[]; prefixPath: TokenType[]; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2637
Parameters
- options: { alternation: Alternation; ambiguityIndices: number[]; prefixPath: TokenType[]; topLevelRule: Rule }
  - alternation: Alternation
  - ambiguityIndices: number[]
  - prefixPath: TokenType[]
  - topLevelRule: Rule
Returns string

buildAlternationPrefixAmbiguityError

buildAlternationPrefixAmbiguityError(options: { alternation: Alternation; ambiguityIndices: number[]; prefixPath: TokenType[]; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2631
Parameters
- options: { alternation: Alternation; ambiguityIndices: number[]; prefixPath: TokenType[]; topLevelRule: Rule }
  - alternation: Alternation
  - ambiguityIndices: number[]
  - prefixPath: TokenType[]
  - topLevelRule: Rule
Returns string

buildDuplicateFoundError

buildDuplicateFoundError(topLevelRule: Rule, duplicateProds: IProductionWithOccurrence[]): string

- Defined in packages/chevrotain/api.d.ts:2626
Parameters
- topLevelRule: Rule
- duplicateProds: IProductionWithOccurrence[]
Returns string

buildDuplicateRuleNameError

buildDuplicateRuleNameError(options: { grammarName: string; topLevelRule: Rule | string }): string

- Defined in packages/chevrotain/api.d.ts:2679
Parameters
- options: { grammarName: string; topLevelRule: Rule | string }
  - grammarName: string
  - topLevelRule: Rule | string
Returns string

buildEmptyAlternationError

buildEmptyAlternationError(options: { alternation: Alternation; emptyChoiceIdx: number; topLevelRule: Rule }): any

- Defined in packages/chevrotain/api.d.ts:2657
Parameters
- options: { alternation: Alternation; emptyChoiceIdx: number; topLevelRule: Rule }
  - alternation: Alternation
  - emptyChoiceIdx: number
  - topLevelRule: Rule
Returns any

buildEmptyRepetitionError

buildEmptyRepetitionError(options: { repetition: IProductionWithOccurrence; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2643
Parameters
- options: { repetition: IProductionWithOccurrence; topLevelRule: Rule }
  - repetition: IProductionWithOccurrence
  - topLevelRule: Rule
Returns string

buildInvalidRuleNameError

buildInvalidRuleNameError(options: { expectedPattern: RegExp; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2675
deprecated
- There are no longer constraints on Rule names
  This method will be removed from the interface in future versions. Providing it will currently have no impact on the runtime.
Parameters
- options: { expectedPattern: RegExp; topLevelRule: Rule }
  - expectedPattern: RegExp
  - topLevelRule: Rule
Returns string

buildLeftRecursionError

buildLeftRecursionError(options: { leftRecursionPath: Rule[]; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2666
Parameters
- options: { leftRecursionPath: Rule[]; topLevelRule: Rule }
  - leftRecursionPath: Rule[]
  - topLevelRule: Rule
Returns string

buildNamespaceConflictError

buildNamespaceConflictError(topLevelRule: Rule): string

- Defined in packages/chevrotain/api.d.ts:2630
Parameters
- topLevelRule: Rule
Returns string

buildTokenNameError

buildTokenNameError(options: { expectedPattern: RegExp; tokenType: TokenType }): any

- Defined in packages/chevrotain/api.d.ts:2652
deprecated
- There are no longer constraints on Token names
  This method will be removed from the interface in future versions. Providing it will currently have no impact on the runtime.
Parameters
- options: { expectedPattern: RegExp; tokenType: TokenType }
  - expectedPattern: RegExp
  - tokenType: TokenType
Returns any

buildTooManyAlternativesError

buildTooManyAlternativesError(options: { alternation: Alternation; topLevelRule: Rule }): string

- Defined in packages/chevrotain/api.d.ts:2662
Parameters
- options: { alternation: Alternation; topLevelRule: Rule }
  - alternation: Alternation
  - topLevelRule: Rule
Returns string

Generated using TypeDoc