README

`@northone/tsconfig`

Use northone base tsconfig

Installation

npm i -D @northone/tsconfig

Usage

Create tsconfig.json and add the following content:

{
  "extends": "./node_modules/@northone/tsconfig/tsconfig",
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ]
}

Override

Override the preset configuration by adding custom compilerOptions.

{
  "extends": "./node_modules/@northone/tsconfig/tsconfig",
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ],
  "compilerOptions": {
    /** Override Options **/
  },
}

Preset Config

Following is the included preset configuration.

{
  "compilerOptions": {
    "lib": [
      "es2017"
    ],
    "moduleResolution": "node",
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "sourceMap": true,
    "declaration": true,
    "importHelpers": true,
    "module": "commonjs",
    "outDir": "lib",
    "rootDir": "src",
    "strict": true,
    "target": "es2017"
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ]
}

Learn more about tsconfig extends at: TypeScript - Project Configuration - Extends

Usage no npm install needed!