@eggjs/tsconfig/README.md

Base tsconfig for egg ts project

# @eggjs/tsconfig

Base tsconfig file for egg project

## Badges

[![NPM version][npm-image]][npm-url]
[![Node.js CI](https://github.com/eggjs/tsconfig/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/tsconfig/actions/workflows/nodejs.yml)
[![NPM quality][quality-image]][quality-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/@eggjs/tsconfig.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@eggjs/tsconfig
[quality-image]: http://npm.packagequality.com/shield/@eggjs/tsconfig.svg?style=flat-square
[quality-url]: http://packagequality.com/#?package=@eggjs/tsconfig
[download-image]: https://img.shields.io/npm/dm/@eggjs/tsconfig.svg?style=flat-square
[download-url]: https://npmjs.org/package/@eggjs/tsconfig

--------------------

## Install

```shell
npm i --save-dev @eggjs/tsconfig
```

## Usage

```json
// tsconfig.json
{
  "extends": "@eggjs/tsconfig",
  // custom config
  "compilerOptions": {
    // override @eggjs/tsconfig options here
  }
}
```