Package Exports

@edx/typescript-config
@edx/typescript-config/tsconfig.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@edx/typescript-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@edx/typescript-config

About

The presence of a tsconfig.json file in a directory indicates that the directory is the root of a TypeScript project. The tsconfig.json file specifies the root files and the compiler options required to compile the project (from https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).

Installation

npx install-peerdeps --dev @edx/typescript-config

This will install the package and all of its peer dependencies.

Usage

Create file in repository tsconfig.json, with a clause "extends": "@edx/typescript-config", adding references to the root directory, output directory, and directories to include/exclude in TypeScript compilation.

{
  "extends": "@edx/typescript-config",
  "compilerOptions": {
    "rootDir": ".",
    "outDir": "dist"
  },
  "include": ["src/**/*"],
  "exclude": ["dist", "node_modules"]
}