What is get-tsconfig?
The get-tsconfig npm package is a utility for finding and reading TypeScript configuration files (tsconfig.json). It simplifies the process of locating the tsconfig.json file and parsing its contents, making it easier to work with TypeScript configurations programmatically.
What are get-tsconfig's main functionalities?
Find the tsconfig.json file
This feature allows you to locate the tsconfig.json file in your project. The `find` function searches for the tsconfig.json file starting from the current directory and moving up the directory tree until it finds one.
const { find } = require('get-tsconfig');
const tsconfigPath = find();
console.log(tsconfigPath);
Read and parse the tsconfig.json file
This feature allows you to read and parse the contents of the tsconfig.json file. The `load` function returns the parsed JSON content of the tsconfig.json file, making it easy to access and manipulate the TypeScript configuration programmatically.
const { load } = require('get-tsconfig');
const tsconfig = load();
console.log(tsconfig);
Specify a custom path to the tsconfig.json file
This feature allows you to specify a custom path to the tsconfig.json file. The `load` function can take a file path as an argument, enabling you to load and parse a tsconfig.json file from a specific location.
const { load } = require('get-tsconfig');
const tsconfig = load('/path/to/your/tsconfig.json');
console.log(tsconfig);
Other packages similar to get-tsconfig
tsconfig-paths
The tsconfig-paths package helps resolve TypeScript paths in Node.js. It reads the paths and baseUrl options from the tsconfig.json file and configures the module resolution accordingly. Unlike get-tsconfig, which focuses on finding and reading the tsconfig.json file, tsconfig-paths is more about resolving module paths based on the TypeScript configuration.
typescript
The typescript package itself provides the TypeScript compiler and related tools, including the ability to read and parse tsconfig.json files. While it offers more comprehensive functionality for working with TypeScript, it is more complex and heavier compared to the lightweight and focused get-tsconfig package.
cosmiconfig
The cosmiconfig package is a universal configuration loader that supports various configuration file formats, including JSON, YAML, and more. It can be used to find and load configuration files like tsconfig.json, but it is more general-purpose and not specifically tailored for TypeScript configurations like get-tsconfig.
get-tsconfig
Find and parse tsconfig.json
files.
Features
- Zero dependency (not even TypeScript)
- Tested against TypeScript for accuracy
- Supports comments & dangling commas in
tsconfig.json
- Resolves
extends
- Fully typed
tsconfig.json
- Validates and throws parsing errors
- Tiny!
3.6 kB
Minified + Gzipped
🚀 Install
npm install get-tsconfig
🙋♀️ Why?
For TypeScript related tooling to correctly parse tsconfig.json
file without depending on TypeScript.
👨🏫 Usage
import { getTsconfig } from 'get-tsconfig'
console.log(getTsconfig())
console.log(getTsconfig('./path/to/index.ts'))
console.log(getTsconfig('./path/to/directory'))
console.log(getTsconfig('./path/to/tsconfig.json'))
⚙️ API
getTsconfig(searchPath?: string, configName?: string)
Searches for a tsconfig.json
file and parses it. Returns null
if a config file cannot be found, or an object containing the path and parsed TSConfig object if found.
Returns:
type TsconfigResult = {
path: string
config: TsConfigJsonResolved
}
searchPath
Type: string
Default: process.cwd()
Accepts a path to a file or directory to search up for a tsconfig.json
file.
configName
Type: string
Default: tsconfig.json
The file name of the TypeScript config file.
createPathsMatcher(tsconfig: TsconfigResult)
Given a tsconfig with compilerOptions.paths
defined, it returns a matcher function.
import { getTsconfig, createPathsMatcher } from 'get-tsconfig'
const tsconfig = getTsconfig()
const pathsMatcher = createPathsMatcher(tsconfig)
The matcher function accepts an import specifier (the path to resolve), checks it against compilerOptions.paths
, and returns an array of possible paths to check:
function pathsMatcher(specifier: string): string[]
This function only returns possible paths and doesn't actually do any resolution. This helps increase compatibility wtih file/build systems which usually have their own resolvers.
FAQ
How can I use TypeScript to parse tsconfig.json
?
This package is a re-implementation of TypeScript's tsconfig.json
parser.
However, if you already have TypeScript as a dependency, you can simply use it's API:
import {
sys as tsSys,
findConfigFile,
readConfigFile,
parseJsonConfigFileContent
} from 'typescript'
const tsconfigPath = findConfigFile(process.cwd(), tsSys.fileExists, 'tsconfig.json')
const tsconfigFile = readConfigFile(tsconfigPath, tsSys.readFile)
const parsedTsconfig = parseJsonConfigFileContent(
tsconfigFile.config,
tsSys,
path.dirname(tsconfigPath)
)