get-tsconfig
Advanced tools
Comparing version 4.6.2 to 4.7.0
{ | ||
"name": "get-tsconfig", | ||
"version": "4.6.2", | ||
"version": "4.7.0", | ||
"description": "Find and parse the tsconfig.json file from a directory path", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
@@ -1,2 +0,2 @@ | ||
# get-tsconfig [![Latest version](https://badgen.net/npm/v/get-tsconfig)](https://npm.im/get-tsconfig) | ||
# get-tsconfig [![Latest version](https://badgen.net/npm/v/get-tsconfig)](https://npm.im/get-tsconfig) [![npm downloads](https://badgen.net/npm/dm/esbuild-loader)](https://npm.im/esbuild-loader) | ||
@@ -12,6 +12,18 @@ Find and parse `tsconfig.json` files. | ||
- Validates and throws parsing errors | ||
- Tiny! `3.6 kB` Minified + Gzipped | ||
- Tiny! `7 kB` Minified + Gzipped | ||
## 🚀 Install | ||
<br> | ||
<p align="center"> | ||
<a href="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=platinum"> | ||
<picture> | ||
<source width="830" media="(prefers-color-scheme: dark)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=platinum&image=dark"> | ||
<source width="830" media="(prefers-color-scheme: light)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=platinum&image"> | ||
<img width="830" src="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=platinum&image" alt="Premium sponsor banner"> | ||
</picture> | ||
</a> | ||
</p> | ||
## Install | ||
```bash | ||
@@ -21,8 +33,8 @@ npm install get-tsconfig | ||
## 🙋♀️ Why? | ||
## Why? | ||
For TypeScript related tooling to correctly parse `tsconfig.json` file without depending on TypeScript. | ||
## ⚙️ API | ||
## API | ||
### getTsconfig(searchPath?, configName?) | ||
### getTsconfig(searchPath?, configName?, cache?) | ||
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. | ||
@@ -60,2 +72,9 @@ | ||
#### cache | ||
Type: `Map<string, any>` | ||
Default: `new Map()` | ||
Optional cache for fs operations. | ||
#### Example | ||
@@ -84,3 +103,3 @@ | ||
### parseTsconfig(tsconfigPath) | ||
### parseTsconfig(tsconfigPath, cache?) | ||
The `tsconfig.json` parser used internally by `getTsconfig`. Returns the parsed tsconfig as `TsConfigJsonResolved`. | ||
@@ -93,2 +112,9 @@ | ||
#### cache | ||
Type: `Map<string, any>` | ||
Default: `new Map()` | ||
Optional cache for fs operations. | ||
#### Example | ||
@@ -105,2 +131,14 @@ | ||
<p align="center"> | ||
<a href="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=gold"> | ||
<picture> | ||
<source width="830" media="(prefers-color-scheme: dark)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=gold&image=dark"> | ||
<source width="830" media="(prefers-color-scheme: light)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=gold&image"> | ||
<img width="830" src="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=gold&image" alt="Premium sponsor banner"> | ||
</picture> | ||
</a> | ||
</p> | ||
--- | ||
### createFileMatcher(tsconfig: TsconfigResult, caseSensitivePaths?: boolean) | ||
@@ -203,1 +241,26 @@ | ||
``` | ||
## Sponsors | ||
<p align="center"> | ||
<a href="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver1"> | ||
<picture> | ||
<source width="410" media="(prefers-color-scheme: dark)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver1&image=dark"> | ||
<source width="410" media="(prefers-color-scheme: light)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver1&image"> | ||
<img width="410" src="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver1&image" alt="Premium sponsor banner"> | ||
</picture> | ||
</a> | ||
<a href="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver2"> | ||
<picture> | ||
<source width="410" media="(prefers-color-scheme: dark)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver2&image=dark"> | ||
<source width="410" media="(prefers-color-scheme: light)" srcset="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver2&image"> | ||
<img width="410" src="https://privatenumber-sponsors.vercel.app/api/sponsor?tier=silver2&image" alt="Premium sponsor banner"> | ||
</picture> | ||
</a> | ||
</p> | ||
<p align="center"> | ||
<a href="https://github.com/sponsors/privatenumber"> | ||
<img src="https://cdn.jsdelivr.net/gh/privatenumber/sponsors/sponsorkit/sponsors.svg"> | ||
</a> | ||
</p> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
101107
129
260