Function createMockTextDocument

createMockTextDocument(
    framework: MockFrameworkLike,
    content?: string,
    languageId?: string,
): {
    _content: string;
    _lines: string[];
    eol: number;
    fileName: string;
    getText: MockFn<[range?: Range], string>;
    getWordRangeAtPosition: MockFn<
        [position: Position, regex?: RegExp],
        Range | undefined,
    >;
    isClosed: boolean;
    isDirty: boolean;
    isUntitled: boolean;
    languageId: string;
    lineAt: MockFn<[lineOrPosition: number | Position], MockTextLine>;
    lineCount: number;
    offsetAt: MockFn<[position: Position], number>;
    positionAt: MockFn<[offset: number], Position>;
    save: MockFn<unknown[], unknown>;
    uri: {
        fsPath: string;
        path: string;
        scheme: string;
        toString: () => string;
    };
    validatePosition: MockFn<[position: Position], Position>;
    validateRange: MockFn<[range: Range], Range>;
    version: number;
}
Creates an immutable LF-oriented text-document fixture with common range/ offset/word queries. It does not mutate after edits, track versions/dirty state, validate bounds like the Extension Host, or fully model CRLF/CR files.
Parameters
- framework: MockFrameworkLike
- content: string = ''
- languageId: string = 'plaintext'
Returns {
    _content: string;
    _lines: string[];
    eol: number;
    fileName: string;
    getText: MockFn<[range?: Range], string>;
    getWordRangeAtPosition: MockFn<
        [position: Position, regex?: RegExp],
        Range | undefined,
    >;
    isClosed: boolean;
    isDirty: boolean;
    isUntitled: boolean;
    languageId: string;
    lineAt: MockFn<[lineOrPosition: number | Position], MockTextLine>;
    lineCount: number;
    offsetAt: MockFn<[position: Position], number>;
    positionAt: MockFn<[offset: number], Position>;
    save: MockFn<unknown[], unknown>;
    uri: {
        fsPath: string;
        path: string;
        scheme: string;
        toString: () => string;
    };
    validatePosition: MockFn<[position: Position], Position>;
    validateRange: MockFn<[range: Range], Range>;
    version: number;
}
- _content: string
  
  Test hook: the raw content this document was built from.
- _lines: string[]
  
  Test hook: the content split into lines.
- eol: number
- fileName: string
- getText: MockFn<[range?: Range], string>
- getWordRangeAtPosition: MockFn<[position: Position, regex?: RegExp], Range | undefined>
- isClosed: boolean
- isDirty: boolean
- isUntitled: boolean
- languageId: string
- lineAt: MockFn<[lineOrPosition: number | Position], MockTextLine>
- lineCount: number
- offsetAt: MockFn<[position: Position], number>
- positionAt: MockFn<[offset: number], Position>
- save: MockFn<unknown[], unknown>
- uri: { fsPath: string; path: string; scheme: string; toString: () => string }
- validatePosition: MockFn<[position: Position], Position>
- validateRange: MockFn<[range: Range], Range>
- version: number
- Defined in src/testing/mock/vscode-mock.ts:1258

Function createMockTextDocument

Parameters

_content: string

_lines: string[]

eol: number

fileName: string

getText: MockFn<[range?: Range], string>

getWordRangeAtPosition: MockFn<[position: Position, regex?: RegExp], Range | undefined>

isClosed: boolean

isDirty: boolean

isUntitled: boolean

languageId: string

lineAt: MockFn<[lineOrPosition: number | Position], MockTextLine>

lineCount: number

offsetAt: MockFn<[position: Position], number>

positionAt: MockFn<[offset: number], Position>

save: MockFn<unknown[], unknown>

uri: { fsPath: string; path: string; scheme: string; toString: () => string }

validatePosition: MockFn<[position: Position], Position>

validateRange: MockFn<[range: Range], Range>

version: number

Settings