tsconfck

tsconfck

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

Why

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

Features

• find closest tsconfig.json
• convert tsconfig.json to actual json and parse it
• resolve "extends"
• optional findNative and parseNative to use official typescript api

Usage

without typescript installed

import { parse } from 'tsconfck';
const {
	filename, // full path to found tsconfig
	tsconfig, // tsconfig object including merged values from extended configs
	extended // separate unmerged results of all tsconfig files
} = await parse('foo/bar.ts');

with typescript

import { parseNative } from 'tsconfck';
const {
	filename, // full path to found tsconfig
	tsconfig, // tsconfig object including merged values from extended configs
	result // output of ts.parseJsonConfigFileContent
} = await parseNative('foo/bar.ts');

Advanced

caching

You should cache results to avoid reparsing if you process multiple ts files that share few tsconfig files

import { find, parse } from 'tsconfck';
const cache = new Map();
const cachedParse = async (filename) => {
	const tsconfigFile = find(filename);
	if (cache.has(tsconfigFile)) {
		return cache.get(tsconfigFile);
	}
	const parseResult = parse(tsconfigFile);
	cache.put(tsconfigFile, parseResult);
	return parseResult;
};

Links

• changelog

Develop

This repo uses

• pnpm
• conventional-changelog/commitlint

In addition to default commit-msg prefixes you can use 'wip: ' for commit messages in branches. 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