https://github.com/softwareventures/tsconfig
Standard TypeScript compiler configuration for Software Ventures Limited
https://github.com/softwareventures/tsconfig
typescript
Last synced: 12 months ago
JSON representation
Standard TypeScript compiler configuration for Software Ventures Limited
- Host: GitHub
- URL: https://github.com/softwareventures/tsconfig
- Owner: softwareventures
- License: isc
- Created: 2018-12-31T04:53:04.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T21:43:42.000Z (almost 2 years ago)
- Last Synced: 2024-04-11T06:24:49.987Z (almost 2 years ago)
- Topics: typescript
- Language: Shell
- Homepage: https://www.npmjs.com/package/@softwareventures/tsconfig
- Size: 1.61 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tsconfig
Standard TypeScript compiler configuration for Software Ventures Limited.
## Install
```bash
npm install --save-dev @softwareventures/tsconfig
```
or for yarn users:
```bash
yarn add --dev @softwareventures/tsconfig
```
We recommend that all packages that use this configuration also add a dependency
on tslib. tslib is needed to support a handful of languages features that are
available in ES2018+ but not ES2017.
```bash
npm install --save tslib
```
or
```bash
yarn add tslib
```
## Usage
Create a `tsconfig.json` file in the root of your project containing:
```json
{
"extends": "@softwareventures/tsconfig"
}
```
The above is the default configuration, which will include the ES2017 API and
generate modules in ESM format (see [advice for migrating to ESM modules][1]).
This configuration is suitable for projects that target node alone, or that
target both node and the browser.
Several alternative configurations are also provided with settings suitable for
other target environments or module formats. To use one of the alternative
configurations, set the `extends` field to one of the values in the table below.
| `extends` | |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `@softwareventures/tsconfig` | The default configuration. Includes ES2017 API and generates modules in ESM format. Suitable for projects that either target node alone, or target both node and the browser. |
| `@softwareventures/tsconfig/commonjs` | Same as default, but generates modules in CommonJS format instead of ESM. |
| `@softwareventures/tsconfig/dom` | Includes DOM API in addition to ES2017. Suitable for use in code targeting browsers or for projects that include a DOM library such as jsdom. |
| `@softwareventures/tsconfig/dom-commonjs` | Same as `dom`, but generates modules in CommonJS format instead of ESM. |
| `@softwareventures/tsconfig/webworker` | Includes WebWorker API in addition to ES2017. Suitable for use in code that will run as a Web Worker. |
| `@softwareventures/tsconfig/webworker-commonjs` | Same as `webworker`, but generates modules in CommonJS format instead of ESM. |
[1]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c