Volt.JS.Lint.TSConfigOverlay (Volt v0.22.0)

Copy Markdown View Source

Puts virtual modules, such as the scripts of a .vue file, into the TypeScript project that covers them.

tsgolint assigns a file to a project by the nearest tsconfig.json that includes it, and expands include by listing directories on disk. A virtual module is not on disk, so it lands in an inferred project with default options: the project's paths do not apply to it, and the declaration files the project includes are not in its program.

tsgolint does read file contents, and a tsconfig.json among them, through the same overrides that carry the virtual modules. So the nearest tsconfig.json is overridden with one that extends the original and names the virtual modules in files. The original is carried unchanged under another name beside it, so relative paths in it keep their meaning.

Summary

Functions

Return the source overrides that add virtual_files to their projects.

Functions

overrides(virtual_files)

@spec overrides([String.t()]) :: %{required(String.t()) => String.t()}

Return the source overrides that add virtual_files to their projects.

A virtual module without a tsconfig.json above it, or whose tsconfig.json cannot be read as an object, is left to the inferred project.