README.md

tsconfig-utils

Utilities for working with tsconfig files

Contents

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

What is this?

This package exports utilities for working with TypeScript configuration files.

When should I use this?

This package can be used to merge and load tsconfig files, as well resolve path aliases.

Install

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>

Use

import {
  isResolvedTsconfig,
  isTsconfigHost,
  loadTsconfig,
  mergeTsconfig,
  readTsconfig,
  resolvePath
} from '@flex-development/tsconfig-utils'

API

This package exports the following identifiers:

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

There is no default export.

Types

This package is fully typed with TypeScript.

Interfaces

• FileSystem
• LoadTsconfigOptions
• ModuleResolutionHost
• ParseConfigHost
• ReadTsconfigOptions
• ResolvePathOptions
• ResolvedTsconfig
• TsconfigHost

tsconfig-types

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.

Related

• mlly — ECMAScript module utilities
• tsconfig-types — TypeScript definitions for tsconfig.json

Contribute

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.