Utilities for working with tsconfig
files
This package exports utilities for working with TypeScript configuration files.
This package can be used to merge and load tsconfig files, as well resolve path aliases.
This package is ESM only.
In Node.js (version 18+) with yarn:
yarn add @flex-development/tsconfig-utils
See Git - Protocols | Yarn for details regarding installing from Git.
In Deno with esm.sh
:
import { loadTsconfig, resolvePath } from 'https://esm.sh/@flex-development/tsconfig-utils'
In browsers with esm.sh
:
<script type="module">
import { loadTsconfig, resolvePath } from 'https://esm.sh/@flex-development/tsconfig-utils'
</script>
import {
isResolvedTsconfig,
isTsconfigHost,
loadTsconfig,
mergeTsconfig,
readTsconfig,
resolvePath
} from '@flex-development/tsconfig-utils'
This package exports the following identifiers:
createModuleResolutionHost
isResolvedTsconfig
isTsconfigHost
loadTsconfig
mergeTsconfig
readTsconfig
resolvePath
There is no default export.
This package is fully typed with TypeScript.
FileSystem
LoadTsconfigOptions
ModuleResolutionHost
ReadTsconfigOptions
ResolvePathOptions
ResolvedTsconfig
TsconfigHost
This package re-exports TypeScript definitions from tsconfig-types
. This is primarily for the
convenience of TypeScript users who do not hoist packages, but may need to import
definitions used in this package.
mlly
— ECMAScript module utilitiestsconfig-types
— TypeScript definitions fortsconfig.json
See CONTRIBUTING.md
.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.