@souyahia/typescript-config

This package provides the TSConfgis that I use in my Typescript projects.

Install

To install the project simply run the following command :

yarn add -D typescript @souyahia/typescript-config

How to use

To use one of the Typescript config exported by this package, place the following code in your tsconfig.json :

{
  "extends": "@souyahia/typescript-config/tsconfig.json",
  "include": ["src", "test"]
}

You can replace tsconfig.json by the name of the config file you want to use.

I also recommend using a second tsconfig file used for building your sources using the command tsc -p tsconfig.build.json. The build file will specify the outDir and exclude the test files like this :

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "exclude": ["test"]
}

Available configs

Here is a list of available Typescript config files exported by this project :

| Name | Usage | |-------------------------|-----------------------------------------------| | tsconfig.json | Base configuration for any typescript project | | tsconfig.angular.json | Base configuration for any Angular 15 project |

Examples

Angular

• tsconfig.json :

{
  "extends": "@souyahia/typescript-config/tsconfig.angular.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "./dist/out-tsc",
    "paths": {
      "app/*": [
        "src/app/*"
      ]
    }
  }
}

• tsconfig.app.json :

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./out-tsc/app",
    "types": []
  },
  "files": [
    "src/main.ts",
    "src/polyfills.ts"
  ],
  "include": [
    "src/**/*.d.ts"
  ]
}

• tsconfig.spec.json :

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./out-tsc/spec",
    "types": [
      "jasmine"
    ]
  },
  "files": [
    "src/test.ts",
    "src/polyfills.ts"
  ],
  "include": [
    "src/**/*.spec.ts",
    "src/**/*.d.ts"
  ]
}