tsconfck

What is tsconfck?

The tsconfck package is a utility for TypeScript configuration management. It helps in resolving and loading TypeScript configuration files (tsconfig.json) by handling inheritance and references within these configurations. This is particularly useful in complex projects where tsconfig settings are split across multiple files or extended from other configurations.

What are tsconfck's main functionalities?

Load and resolve tsconfig.json

This feature allows loading a tsconfig.json file, resolving all its extends and references to provide a final resolved configuration object. It handles the asynchronous nature of file reading and parsing, providing a promise-based API.

const { loadTsconfig } = require('tsconfck');

loadTsconfig('path/to/tsconfig.json').then(tsconfig => {
  console.log(tsconfig);
}).catch(error => {
  console.error(error);
});

Other packages similar to tsconfck

tsconfig-paths

tsconfig-paths is a package that helps in resolving and loading paths from tsconfig.json files for module resolution. Unlike tsconfck, which focuses more broadly on configuration loading and resolution, tsconfig-paths specifically targets path resolution to aid in module loading in non-TypeScript environments.

tsconfig-loader

tsconfig-loader provides functionality to load tsconfig.json files without resolving the entire configuration. It's simpler than tsconfck as it does not handle the resolution of 'extends' or other complex configurations, focusing instead on direct loading of configurations as they are defined.

README

tsconfck

A utility to find and parse tsconfig files without depending on typescript

Why

Because no simple official api exists and tsconfig isn't actual json.

Features

• find closest tsconfig (tsconfig.json or jsconfig.json)
• convert tsconfig to actual json and parse it
• resolve "extends"
• resolve "references" of solution-style tsconfig
• optional caching for improved performance
• optional findNative and parseNative to use official typescript api
• zero dependencies (typescript optional)
• extensive testsuite
• completely async and optimized (it's fast)
• tiny 4.8KB gzip
• unbundled esm js, no sourcemaps needed
• types generated with dts-buddy

Users

Used by vite*, vite-tsconfig-paths, astro and many more

(*) vite bundles tsconfck so it is listed as a devDependency

Install

npm install --save-dev tsconfck # or pnpm, yarn

Usage

without typescript installed

import { parse } from 'tsconfck';
const {
	tsconfigFile, // full path to found tsconfig
	tsconfig, // tsconfig object including merged values from extended configs
	extended, // separate unmerged results of all tsconfig files that contributed to tsconfig
	solution, // solution result if tsconfig is part of a solution
	referenced // referenced tsconfig results if tsconfig is a solution
} = await parse('foo/bar.ts');

with typescript

import { parseNative } from 'tsconfck';
const {
	tsconfigFile, // full path to found tsconfig
	tsconfig, // tsconfig object including merged values from extended configs, normalized
	result, // output of ts.parseJsonConfigFileContent
	solution, // solution result if tsconfig is part of a solution
	referenced // referenced tsconfig results if tsconfig is a solution
} = await parseNative('foo/bar.ts');

API

see API-DOCS

Advanced

ignoring tsconfig for files inside node_modules

esbuild ignores node_modules so when you want to use tsconfck with esbuild, you can set ignoreNodeModules: true

import { find, parse } from 'tsconfck';
// returns some-lib/tsconfig.json
const fooTSConfig = await find('node_modules/some-lib/src/foo.ts');

// returns null
const fooTSConfigIgnored = await find('node_modules/some-lib/src/foo.ts', {
	ignoreNodeModules: true
});

// returns empty config
const { tsconfig } = await parse('node_modules/some-lib/src/foo.ts', { ignoreNodeModules: true });

caching

a TSConfckCache instance can be created and passed to find and parse functions to reduce overhead when they are called often within the same project

import { find, parse, TSCOnfckCache } from 'tsconfck';
// 1. create cache instance
const cache = new TSCOnfckCache();
// 2. pass cache instance in options
const fooTSConfig = await find(('src/foo.ts', { cache })); // stores tsconfig for src in cache
const barTSConfig = await find(('src/bar.ts', { cache })); // reuses tsconfig result for src without fs call

const fooResult = await parse('src/foo.ts', { cache }); // uses cached path for tsconfig, stores parse result in cache
const barResult = await parse('src/bar.ts', { cache }); // uses cached parse result without fs call or resolving

cache invalidation

You are responsible for clearing the cache if tsconfig files are added/removed/changed after reading them during the cache lifetime.

Call cache.clear() and also discard all previous compilation results based previously cached configs.

cache mutation

Returned results are direct cache objects. If you want to modify them, deep-clone first.

cache reuse

Never use the same cache instance for mixed calls of find/findNative or parse/parseNative as result structures are different

root

This option can be used to limit finding tsconfig files outside of a root directory

import { parse, TSConfckCache } from 'tsconfck';
const root = '.';
const parseOptions = { root };
// these calls are not going to look for tsconfig files outside root
const fooResult = await find('src/foo.ts', parseOptions);
const barResult = await parse('src/bar.ts', parseOptions);

Using the root option can lead to errors if there is no tsconfig found inside root.

error handling

find and parse reject for errors they encounter, but return null or empty result if no config was found

If you want them to error instead, test the result and throw

import { parse } from 'tsconfck';
find('some/path/without/tsconfig/foo.ts').then((result) => {
	if (result === null) {
		throw new Error('not found');
	}
	return result;
});
parse('some/path/without/tsconfig/foo.ts').then((result) => {
	if (result.tsconfigFile === null) {
		throw new Error('not found');
	}
	return result;
});

TSConfig type (optional, requires typescript as devDependency)

import type { TSConfig } from 'pkg-types';

Check out https://github.com/unjs/pkg-types

cli

A simple cli wrapper is included, you can use it like this

find

# prints /path/to/tsconfig.json on stdout
tsconfck find src/index.ts

find-all

# prints all tsconfig.json in dir on stdout
tsconfck find-all src/

parse

# print content of ParseResult.tsconfig on stdout
tsconfck parse src/index.ts

# print to file
tsconfck parse src/index.ts > output.json

parse-result

# print content of ParseResult on stdout
tsconfck parse-result src/index.ts

# print to file
tsconfck parse-result src/index.ts > output.json

help

# print usage
tsconfck -h # or --help, -?, help

Links

• changelog

Develop

This repo uses

• pnpm
• changesets

In every PR you have to add a changeset by running pnpm changeset and following the prompts

PRs are going to be squash-merged

# install dependencies
pnpm install
# run tests
pnpm test
#run tests in watch mode (doesn't require dev in parallel)
pnpm test:watch

License

MIT