Class DefaultDocumentValidator

Language-specific service for validating LangiumDocuments.

Implements

DocumentValidator

Index

Constructors

constructor

new DefaultDocumentValidator(
services: LangiumCoreServices,
): DefaultDocumentValidator
Parameters
- services: LangiumCoreServices
Returns DefaultDocumentValidator
- Defined in packages/langium/src/validation/document-validator.ts:70

Properties

`Protected` `Readonly`languageId

languageId: string

`Protected` `Readonly`metadata

metadata: LanguageMetaData

`Protected` `Readonly`profiler

profiler: undefined | LangiumProfiler

`Protected` `Readonly`validationRegistry

validationRegistry: ValidationRegistry

Methods

`Protected`getSource

getSource(): undefined | string
Returns undefined | string
- Defined in packages/langium/src/validation/document-validator.ts:289

`Protected`processLexingErrors

processLexingErrors(
    parseResult: ParseResult,
    diagnostics: Diagnostic[],
    _options: ValidationOptions,
): void
Parameters
- parseResult: ParseResult
- diagnostics: Diagnostic[]
- _options: ValidationOptions
Returns void
- Defined in packages/langium/src/validation/document-validator.ts:115

`Protected`processLinkingErrors

processLinkingErrors(
    document: LangiumDocument,
    diagnostics: Diagnostic[],
    _options: ValidationOptions,
): void
Parameters
- document: LangiumDocument
- diagnostics: Diagnostic[]
- _options: ValidationOptions
Returns void
- Defined in packages/langium/src/validation/document-validator.ts:176

`Protected`processParsingErrors

processParsingErrors(
    parseResult: ParseResult,
    diagnostics: Diagnostic[],
    _options: ValidationOptions,
): void
Parameters
- parseResult: ParseResult
- diagnostics: Diagnostic[]
- _options: ValidationOptions
Returns void
- Defined in packages/langium/src/validation/document-validator.ts:139

`Protected`toDiagnostic

toDiagnostic<N extends AstNode>(
    severity: ValidationSeverity,
    message: string,
    info: DiagnosticInfo<N, string>,
): Diagnostic
Type Parameters
- N extends AstNode
Parameters
- severity: ValidationSeverity
- message: string
- info: DiagnosticInfo<N, string>
Returns Diagnostic
- Defined in packages/langium/src/validation/document-validator.ts:275

`Protected`validateAst

validateAst(
    rootNode: AstNode,
    options: ValidationOptions,
    cancelToken?: Cancellation.CancellationToken,
): Promise<Diagnostic[]>
Parameters
- rootNode: AstNode
- options: ValidationOptions
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<Diagnostic[]>
- Defined in packages/langium/src/validation/document-validator.ts:197

`Protected`validateAstAfter

validateAstAfter(
    rootNode: AstNode,
    options: ValidationOptions,
    acceptor: ValidationAcceptor,
    cancelToken?: Cancellation.CancellationToken,
): Promise<void>
Parameters
- rootNode: AstNode
- options: ValidationOptions
- acceptor: ValidationAcceptor
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<void>
- Defined in packages/langium/src/validation/document-validator.ts:267

`Protected`validateAstBefore

validateAstBefore(
    rootNode: AstNode,
    options: ValidationOptions,
    acceptor: ValidationAcceptor,
    cancelToken?: Cancellation.CancellationToken,
): Promise<void>
Parameters
- rootNode: AstNode
- options: ValidationOptions
- acceptor: ValidationAcceptor
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<void>
- Defined in packages/langium/src/validation/document-validator.ts:210

`Protected`validateAstNodes

validateAstNodes(
    rootNode: AstNode,
    options: ValidationOptions,
    acceptor: ValidationAcceptor,
    cancelToken?: Cancellation.CancellationToken,
): Promise<void>
Parameters
- rootNode: AstNode
- options: ValidationOptions
- acceptor: ValidationAcceptor
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<void>
- Defined in packages/langium/src/validation/document-validator.ts:218

validateDocument

validateDocument(
    document: LangiumDocument,
    options?: ValidationOptions,
    cancelToken?: Cancellation.CancellationToken,
): Promise<Diagnostic[]>
Validates the whole specified document.
Parameters
- document: LangiumDocument
  specified document to validate
- options: ValidationOptions = {}
  options to control the validation process
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
  allows to cancel the current operation
Returns Promise<Diagnostic[]>
Throws
OperationCanceled if a user action occurs during execution
Implementation of DocumentValidator.validateDocument
- Defined in packages/langium/src/validation/document-validator.ts:77

`Protected`validateSingleNodeOptions

validateSingleNodeOptions(
_node: AstNode,
_options: ValidationOptions,
): ValidateSingleNodeOptions
Parameters
- _node: AstNode
- _options: ValidationOptions
Returns ValidateSingleNodeOptions
- Defined in packages/langium/src/validation/document-validator.ts:263

Class DefaultDocumentValidator

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DefaultDocumentValidator

Properties

Protected ReadonlylanguageId

Protected Readonlymetadata

Protected Readonlyprofiler

Protected ReadonlyvalidationRegistry

Methods

ProtectedgetSource

Returns undefined | string

ProtectedprocessLexingErrors

Parameters

Returns void

ProtectedprocessLinkingErrors

Parameters

Returns void

ProtectedprocessParsingErrors

Parameters

Returns void

ProtectedtoDiagnostic

Type Parameters

Parameters

Returns Diagnostic

ProtectedvalidateAst

Parameters

Returns Promise<Diagnostic[]>

ProtectedvalidateAstAfter

Parameters

Returns Promise<void>

ProtectedvalidateAstBefore

Parameters

Returns Promise<void>

ProtectedvalidateAstNodes

Parameters

Returns Promise<void>

validateDocument

Parameters

Returns Promise<Diagnostic[]>

Throws

ProtectedvalidateSingleNodeOptions

Parameters

Returns ValidateSingleNodeOptions

Settings

On This Page

`Protected` `Readonly`languageId

`Protected` `Readonly`metadata

`Protected` `Readonly`profiler

`Protected` `Readonly`validationRegistry

`Protected`getSource

`Protected`processLexingErrors

`Protected`processLinkingErrors

`Protected`processParsingErrors

`Protected`toDiagnostic

`Protected`validateAst

`Protected`validateAstAfter

`Protected`validateAstBefore

`Protected`validateAstNodes

`Protected`validateSingleNodeOptions