get-tsconfig

Find and/or parse the tsconfig.json file from a file or directory path

Usage no npm install needed!

<script type="module">
  import getTsconfig from 'https://cdn.skypack.dev/get-tsconfig';
</script>

README

get-tsconfig Latest version Monthly downloads Install size Bundle size

Find and/or parse the tsconfig.json file from a file or directory path.

Features

  • Uses TypeScript API under the hood so it's guaranteed to behave accurately
  • Supports comments & dangling commas
  • Resolves extends
  • Validates and throws parsing errors
  • Tiny! 710 bytes

🚀 Install

npm install --save-dev typescript get-tsconfig

🙋‍♀️ Why?

TypeScript exports methods to find and prase tsconfig.json but they're not well documented or discoverable. This could lead to others making custom implementations that don't meet feature parity with the TypeScript configuration spec.

This package exports a single function that finds and parses the tsconfig.json using TypeScript via peer dependency.

👨‍🏫 Usage

import getTsconfig from 'get-tsconfig'

// Finds tsconfig.json in the current directory
console.log(getTsconfig())

// Find tsconfig.json from a TypeScript file path
console.log(getTsconfig('./path/to/index.ts'))

// Find tsconfig.json from a directory file path
console.log(getTsconfig('./path/to/directory'))

// Explicitly pass in tsconfig.json path
console.log(getTsconfig('./path/to/tsconfig.json'))

⚙️ API

getTsconfig(filePath?: string): Tsconfig

Returns the parsed TSConfig object. Throws an error if tsconfig.json cannot be found or it cannot be parsed.

filePath

Type: string

Default: process.cwd()

Accepts:

  • Path to a file or directory to search up for a tsconfig.json file
  • Path to the tsconfig.json file