@apitree.cz/ts-config v0.2.3

TS Config

TypeScript configuration for ApiTree projects

Installation

pnpm add --save-dev @apitree.cz/ts-config typescript

Usage

Add one of the following configurations to your tsconfig.json:

Library

Suitable for distributable npm packages (both Node.js and React).

{
  "extends": "@apitree.cz/ts-config/library",
  "include": [".eslintrc.cjs", "**/*.js", "**/*.ts"],
  "exclude": ["dist", "node_modules"]
}

Note: If you are using React, you should also add "**/*.tsx" to the include array.

CommonJS library

Suitable for distributable npm packages (Node.js only).

{
  "extends": "@apitree.cz/ts-config/cjs-library",
  "include": [".eslintrc.cjs", "**/*.js", "**/*.ts"],
  "exclude": ["dist", "node_modules"]
}

App

Suitable for stand-alone applications (both Node.js and React).

{
  "extends": "@apitree.cz/ts-config/app",
  "include": [".eslintrc.cjs", "**/*.js", "**/*.ts"],
  "exclude": ["build", "node_modules"]
}

Note: If you are using React, you should also add "**/*.tsx" to the include array.

Next.js

Suitable for Next.js apps.

{
  "extends": "@apitree.cz/ts-config/next",
  "include": [".eslintrc.cjs", "next-env.d.ts", "**/*.js", "**/*.ts", "**/*.tsx"],
  "exclude": [".next", "node_modules"]
}

Nest.js

Suitable for Nest.js apps.

{
  "extends": "@apitree.cz/ts-config/nestjs",
  "include": [".eslintrc.js", "**/*.js", "**/*.ts"],
  "exclude": ["build", "node_modules"]
}

Nest.js Library

Suitable for distributable npm packages consumed by Nest.js apps.

{
  "extends": "@apitree.cz/ts-config/nestjs-library",
  "include": [".eslintrc.js", "**/*.js", "**/*.ts"],
  "exclude": ["dist", "node_modules"]
}