@rainstormy/preset-typescript NPM

Presets for TypeScript

This package provides predefined, opinionated TypeScript configuration.

Installation

Install the @rainstormy/preset-typescript package and its peer dependencies:

npm install --save-dev @rainstormy/preset-typescript typescript

pnpm install --save-dev @rainstormy/preset-typescript typescript

yarn add --dev @rainstormy/preset-typescript typescript

Usage

Create a TypeScript configuration file (tsconfig.json) and extend the following configurations to enable type-checking and optionally also generation of js and d.ts files:

@rainstormy/preset-typescript/check
@rainstormy/preset-typescript/generate (to generate js and d.ts files)
@rainstormy/preset-typescript/generate-types (to generate d.ts files only)
@rainstormy/preset-typescript/target-node-es2023 (for Node.js projects)
@rainstormy/preset-typescript/target-web-es2023 (for web browser projects)

For example:

{
	"$schema": "https://json.schemastore.org/tsconfig",
	"extends": [
		"@rainstormy/preset-typescript/check",
		"@rainstormy/preset-typescript/target-web-es2023"
	]
}

To override the settings configured by this preset, specify the desired options after the extends field to take precedence over the preset. For example:

{
	"$schema": "https://json.schemastore.org/tsconfig",
	"extends": [
		"@rainstormy/preset-typescript/check",
		"@rainstormy/preset-typescript/generate",
		"@rainstormy/preset-typescript/target-node-es2023"
	],
	"compilerOptions": {
		"baseUrl": "./",
		"incremental": true,
		"noEmitOnError": false,
		"outDir": "dist",
		"sourceMap": true
	},
	"include": ["./src/**/*.ts", "./*.config.js", "./*.config.ts"]
}

Complementary Presets

tsconfig typescript

1.0.0-alpha.3

2 years ago

1.0.0-alpha.2

2 years ago