README
Supercharge shareable TypeScript Config
Shared TypeScript config for Supercharge projects
Follow @marcuspoehls and @superchargejs for updates!
Installation
npm i -D @supercharge/tsconfig
Targets
Major Release | Node.js version |
---|---|
3.x |
14.x |
2.x |
12.x |
1.x |
8.x |
Usage
Create a tsconfig.json
file in your project and extends the @supercharge/tsconfig
TypeScript config:
Basic Usage
When installed, configure your tsconfig.json
like this:
{
"extends": "@supercharge/tsconfig",
"compilerOptions": {
"outDir": "dist"
}
}
Refined Configuration
You can refine your tsconfig.json
to your needs. Let’s say you want to target Node.js v14 instead of v12 (which is the default). Change your compilerOptions
to this:
{
"extends": "@supercharge/tsconfig",
"display": "Node 14",
"compilerOptions": {
"outDir": "dist",
"lib": ["es2020"],
"target": "es2020",
}
}
Customizing your compilerOptions
when extending the @supercharge/tsconfig
package only overrides the listed properties. Every other option defined in the base configuration will be inherited.
Contributing
- Create a fork
- Create your feature branch:
git checkout -b my-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request 🚀
License
MIT © Supercharge
superchargejs.com · GitHub @supercharge · Twitter @superchargejs