# resolve-tsconfig

> Find and resolve a tsconfig with some options.

Latest version **1.3.0** (published 2022-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install resolve-tsconfig
pnpm add resolve-tsconfig
yarn add resolve-tsconfig
bun add resolve-tsconfig
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2022-10-29 |
| First published | 2022-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 0 |
| Unpacked size | 35.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | skarab42 |
| Maintainers | skarab |
| Keywords | typescript, tsconfig, config, diagnostics |

## Links

- npm: https://www.npmjs.com/package/resolve-tsconfig
- Repository: https://github.com/skarab42/resolve-tsconfig
- Issues: https://github.com/skarab42/resolve-tsconfig/issues
- Funding: https://github.com/sponsors/skarab42
- npm.io page: https://npm.io/package/resolve-tsconfig

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2022-10-29
- 1.2.0 — 2022-10-28
- 1.1.0 — 2022-10-28
- 1.0.0 — 2022-10-26

## README

# resolve-tsconfig

Find and resolve a tsconfig with some options.

## Installation

```bash
pnpm add resolve-tsconfig
```

## Usage

```ts
import { resolveTsConfig } from 'resolve-tsconfig';

const { config, diagnostics } = resolveTsConfig();
```

## Signature

```ts
function resolveTsConfig(options?: ResolveTsConfigOptions): ResolvedTsConfig;
```

### Options

- **filePath**: `string | undefined` - Default to `tsconfig.json`.
- **startDirectory**: `string | undefined` - Default to current workind directory.
- **stopDirectory**: `string | undefined` - Default to root directory.
- **startDirectoryShouldExists**: `boolean | undefined` - Default to `false`.

### Return

```ts
type ResolvedTsConfig =
  | { diagnostics: ts.Diagnostic[]; config?: never }
  | { config: ts.ParsedCommandLine; diagnostics?: never };
```

---

Scaffolded with [@skarab/skaffold](https://www.npmjs.com/package/@skarab/skaffold)

---
_Source: https://npm.io/package/resolve-tsconfig · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._