TSConfig
TypeScript configuration file specified in tsconfig.json, used for import resolution and computing dependencies.
Attributes
base_config
Returns the base TSConfig that this config inherits from.
base_url
str | None
Returns the base URL defined in the TypeScript configuration.
config
dict
config_file
config_parser
TSConfigParser
out_dir
str | None
Returns the outDir defined in the TypeScript configuration.
path_import_aliases
dict[str, list[str]]
Returns a formatted version of the paths property from a TypeScript configuration file.
paths
dict[str, list[str]]
Returns all custom module path mappings defined in the tsconfig file.
reference_import_aliases
dict[str, list[str]]
Returns a formatted version of the references property from a TypeScript configuration file.
references
Returns a list of directories that this TypeScript configuration file depends on.
root_dir
str | None
Returns the rootDir defined in the TypeScript configuration.
root_dirs
list[str]
Returns the rootDirs defined in the TypeScript configuration.
Methods
resolve_base_url
Resolves an import path with the base url.
Returns
str
translate_absolute_path
Translates an absolute path to an import path using the tsconfig paths.
Parameters
str
The absolute path to translate.
Returns
str
The translated import path.
translate_import_path
Translates an import path to an absolute path using the tsconfig paths.
Parameters
str
The import path to translate.
Returns
str
The translated absolute path. If no matching path alias is found, returns the original import path unchanged.
Was this page helpful?