@bricked/ts-config
Shared typescript configuration for my projects.
Installation
npm install --save-dev @bricked/ts-config
yarn add --save-dev @bricked/ts-config
pnpm add --save-dev @bricked/ts-config
Usage
Base Config
You can use tsconfig.json
by extending it in yours:
{
"extends": "@bricked/ts-config"
}
This is a config suited for nearly all projects, but you may extend it with your own config options.
Platform Specific Config
It's recommended to use one of the platform specific configs:
- configure for NodeJS using
node.json
{
"extends": "@bricked/ts-config/node"
}
- configure for browsers using
dom.json
{
"extends": "@bricked/ts-config/dom"
}
- configure for bundlers using
bundler.json
{
"extends": "@bricked/ts-config/bundler"
}
This will add additional typings for the specified platform. Additionally it can alter the behaviour of for example global variables.
Feature Specific Config
You may add feature specific configs to enable / enforce certain features:
- enforce more strict rules using
strict.json
:
{
"extends": "@bricked/ts-config/strict"
}
- enable experimental support for decorators using
decorators.json
{
"extends": "@bricked/ts-config/decorators"
}
Feature specific configs may be combined like this:
{
"extends": [
"@bricked/ts-config/node",
"@bricked/ts-config/strict",
"@bricked/ts-config/decorators"
]
}