https://github.com/adonisjs-community/adonis-preset-ts

Tsconfig and tslint config presets for AdonisJs projects
https://github.com/adonisjs-community/adonis-preset-ts

Last synced: 8 days ago
JSON representation

Tsconfig and tslint config presets for AdonisJs projects

• Host: GitHub
• URL: https://github.com/adonisjs-community/adonis-preset-ts
• Owner: adonisjs-community
• License: mit
• Created: 2019-07-29T07:32:56.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-04T04:24:59.000Z (almost 2 years ago)
• Last Synced: 2025-01-14T11:05:40.602Z (10 days ago)
• Size: 202 KB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  








[![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]






# Adonis Preset Typescript

This module contains the base config files **(recommended by the core team)** for `typescript` to be extended by your AdonisJS typescript projects.

## Usage

Install the package from npm registry as follows

```sh

npm i -D adonis-preset-ts

# yarn

yarn add -D adonis-preset-ts

```

and then setup your config file to extend the base config

**tsconfig.json**

```json

{

  "extends": "./node_modules/adonis-preset-ts/tsconfig",

  "compilerOptions": {

    "types": [

      "@adonisjs/core"

    ],

    "outDir": "./build",

    "rootDir": "./",

    "paths": {

      "App/*": ["./app/*"],

      "Config/*": ["./config/*"],

      "Contracts/*": ["./contracts/*"],

      "Database/*": ["./database/*"]

    }

  },

  "include": ["**/*"],

  "exclude": ["node_modules", "build"]

}

```



  Built with ❤︎ by Harminder Virk





[npm-image]: https://img.shields.io/npm/v/adonis-preset-ts/latest.svg?style=for-the-badge&logo=npm

[npm-url]: https://www.npmjs.com/package/adonis-preset-ts/v/alpha "npm"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[license-url]: LICENSE.md

[license-image]: https://img.shields.io/github/license/adonisjs-community/adonis-preset-ts?style=for-the-badge

[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs-community/adonis-preset-ts?label=Synk%20Vulnerabilities&style=for-the-badge

[synk-url]: https://snyk.io/test/github/adonisjs-community/adonis-preset-ts?targetFile=package.json "synk"