@eggjs/tsconfig/README.md

Base tsconfig for egg ts project

# @eggjs/tsconfig

[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[![Node.js Version](https://img.shields.io/node/v/@eggjs/tsconfig.svg?style=flat)](https://nodejs.org/en/download/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/egg)

[npm-image]: https://img.shields.io/npm/v/@eggjs/tsconfig.svg?style=flat-square
[npm-url]: https://npmjs.org/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

Base tsconfig file for egg project

## Install

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

## Usage

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

## License

[MIT](LICENSE)

## Contributors

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

Made with [contributors-img](https://contrib.rocks).