https://github.com/adonisjs/tsconfig
Base TypeScript configuration files for AdonisJS applications and packages
https://github.com/adonisjs/tsconfig
Last synced: 10 months ago
JSON representation
Base TypeScript configuration files for AdonisJS applications and packages
- Host: GitHub
- URL: https://github.com/adonisjs/tsconfig
- Owner: adonisjs
- License: mit
- Created: 2024-08-31T11:47:05.000Z (almost 2 years ago)
- Default Branch: 1.x
- Last Pushed: 2025-05-28T09:19:50.000Z (about 1 year ago)
- Last Synced: 2025-05-28T09:26:02.984Z (about 1 year ago)
- Size: 6.84 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @adonisjs/tsconfig
Base TSConfig files
TSConfig config files for AdonisJS (including Inertia) applications or AdonisJS packages.
[![npm-image]][npm-url] [![license-image]][license-url]
## Installation
Install the package from the npm registry.
```sh
npm i -D @adonisjs/tsconfig@beta
# Make sure also to install the following packages
npm i -D typescript ts-node-maintained @swc/core
```
## Usage
After installation, use one of the following base config files.
**For package development**
```json
// tsconfig.json
{
"extends": "@adonisjs/tsconfig/tsconfig.package.json",
"compilerOptions": {
"rootDir": "./",
"outDir": "./build"
}
}
```
**For AdonisJS application**
```json
// tsconfig.json
{
"extends": "@adonisjs/tsconfig/tsconfig.app.json",
"compilerOptions": {
"rootDir": "./",
"outDir": "./build"
}
}
```
**For client-side code inside AdonisJS application**
```ts
// resources/tsconfig.json
{
"extends": "@adonisjs/tsconfig/tsconfig.client.json"
}
```
[npm-image]: https://img.shields.io/npm/v/@adonisjs/tsconfig/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adonisjs/tsconfig/v/latest 'npm'
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs/tsconfig?style=for-the-badge