Installation

npm i -D @supercharge/tsconfig

Targets

| Major Release | Node.js version | Module System | | ------------- | --------------- | ------------ | | 8.x | 22.x | ESM | | 7.x | 20.x | ESM | | 6.x | 20.x | CommonJS | | 5.x | 18.x | CommonJS | | 4.x | 16.x | CommonJS | | 3.x | 14.x | CommonJS | | 2.x | 12.x | CommonJS | | 1.x | 8.x | CommonJS |

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 v16. Change your compilerOptions to this:

{
  "extends": "@supercharge/tsconfig",
  "display": "Node.js v16",

  "compilerOptions": {
    "outDir": "dist",
    "target": "ES2021",
    "lib": ["ES2021"]
  }
}

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

1. Create a fork
2. Create your feature branch: git checkout -b my-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 🚀

License

MIT © Supercharge

superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs