resolveIncludes

resolveIncludes(entry, entryFormat, fileProvider): Promise<{ diagnostics: Diagnostic[]; source: CompositeSource; }>

Defined in: preprocess/include/resolver.ts:226

Resolve all includes from an entry file

Parameters

entry

string

Canonical path to entry file

entryFormat

Format of entry file (inferred if not provided)

SourceFormat | undefined

fileProvider

FileProvider

File provider for reading files

Returns

Promise<{ diagnostics: Diagnostic[]; source: CompositeSource; }>

CompositeSource with resolved includes and diagnostics

Example

const { source, diagnostics } = await resolveIncludes(
  '/spec/format.md',
  'markdown',
  fileProvider
);

// source.units is ordered by document flow
for (const unit of source.units) {
  console.log(`${unit.file}:${unit.startLine}`);
}