Function toContainIssue

  • toContainIssue(
        document: LangiumDocument<AstNode> | ParsedDocument,
        expectedIssue: IssueExpectation,
        parameters?: IgnoreParameters,
    ): { message: () => string; pass: boolean }

    Expects that a specific issue is present in the Langium document.

    Parameters

    • document: LangiumDocument<AstNode> | ParsedDocument

      The Langium document or parsed document to check for the issue.

    • expectedIssue: IssueExpectation

      The expected issue to look for.

    • Optionalparameters: IgnoreParameters

      Optional parameters to customize which issues to ignore.

    Returns { message: () => string; pass: boolean }

    Example

    import { expect, test } from 'vitest';
    import { parse } from './your-langium-test-setup';

    test('document contains specific issue', async () => {
      const doc = await parse('const x = @;', { validation: true });
      expect(doc).toContainIssue({
        message: /Unexpected character/,
        severity: DocumentIssueSeverity.ERROR,
        source: DocumentIssueSource.LEXER,
      });
    });

Settings

Member Visibility