flex-development/tsconfig-utils

Utilities for working with tsconfig files

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
  • tsconfig-types
  • Interfaces
  • Types
• Related
• Contribute

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:

• createGetCanonicalFileName
• createModuleResolutionHost
• createParseConfigHost
• isResolvedTsconfig
• isTsconfigHost
• loadTsconfig
• mergeTsconfig
• readTsconfig
• resolvePath

There is no default export.

This package is fully typed with TypeScript.

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.

• Dirent
• FileSystem
• LoadTsconfigOptions
• ModuleResolutionHostOptions
• ModuleResolutionHost
• ParseConfigHostOptions
• ParseConfigHost
• ReadTsconfigOptions
• ResolvePathOptions
• ResolvedTsconfig
• TsconfigHost

• GetCanonicalFileName
• ReadDirectory

• mlly — ECMAScript module utilities
• tsconfig-types — TypeScript definitions for tsconfig.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.