# @supercharge/tsconfig

> Shareable TypeScript config

Latest version **8.0.1** (published 2024-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @supercharge/tsconfig
pnpm add @supercharge/tsconfig
yarn add @supercharge/tsconfig
bun add @supercharge/tsconfig
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.0.1 |
| Published | 2024-05-04 |
| First published | 2020-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=22 |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Marcus Pöhls |
| Maintainers | marcuspoehls, peitek, celsiusf |
| Keywords | tsconfig, esm, typescript, ts, config, configuration, supercharge, superchargejs |

## Links

- npm: https://www.npmjs.com/package/@supercharge/tsconfig
- Repository: https://github.com/supercharge/tsconfig
- Issues: https://github.com/supercharge/tsconfig/issues
- npm.io page: https://npm.io/package/@supercharge/tsconfig

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 8.0.1 (latest) — 2024-05-04
- 8.0.0 — 2024-05-04
- 7.0.0 — 2023-10-15
- 6.0.0 — 2023-10-15
- 5.0.0 — 2023-07-30
- 4.0.0 — 2022-06-16
- 3.1.0 — 2021-08-30
- 2.1.0 — 2021-08-30
- 3.0.0 — 2021-06-10
- 2.0.0 — 2021-06-10
- 1.0.0 — 2020-05-06

## README

<div align="center">
  <a href="https://superchargejs.com">
    <img width="471" style="max-width:100%;" src="https://superchargejs.com/images/supercharge-text.svg" />
  </a>
  <br/>
  <br/>
  <p>
    <h3>Supercharge shareable TypeScript Config</h3>
  </p>
  <p>
    Shared TypeScript config for Supercharge projects
  </p>
  <br/>
  <p>
    <a href="#installation"><strong>Installation</strong></a> ·
    <a href="#usage"><strong>Usage</strong></a>
  </p>
  <br/>
  <br/>
  <p>
    <a href="https://www.npmjs.com/package/@supercharge/tsconfig"><img src="https://img.shields.io/npm/v/@supercharge/tsconfig.svg" alt="Latest Version"></a>
    <a href="https://www.npmjs.com/package/@supercharge/tsconfig"><img src="https://img.shields.io/npm/dm/@supercharge/tsconfig.svg" alt="Monthly downloads">
  </p>
  <p>
    <em>Follow <a href="http://twitter.com/marcuspoehls">@marcuspoehls</a> and <a href="http://twitter.com/superchargejs">@superchargejs</a> for updates!</em>
  </p>
</div>

---

## 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](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html):

### Basic Usage
When installed, configure your `tsconfig.json` like this:

```json
{
  "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:

```json
{
  "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](https://superchargejs.com)

---

> [superchargejs.com](https://superchargejs.com) &nbsp;&middot;&nbsp;
> GitHub [@supercharge](https://github.com/supercharge) &nbsp;&middot;&nbsp;
> Twitter [@superchargejs](https://twitter.com/superchargejs)

---
_Source: https://npm.io/package/@supercharge/tsconfig · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
