Skip to content

Commit

Permalink
add note about setting types in tsconfig file (#3300)
Browse files Browse the repository at this point in the history
refs #3226
  • Loading branch information
tjenkinson authored and lukastaegert committed Dec 25, 2019
1 parent 8e7a447 commit 7158c06
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/00-introduction.md
Expand Up @@ -12,6 +12,8 @@ Rollup is a module bundler for JavaScript which compiles small pieces of code in
npm install --global rollup
```

⚠️ If you are using TypeScript, we recommend you explicitly list the `@types` packages you want to use using the [`types` property in the "tsconfig.json" file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types), or set it to `[]`. Rollup has a dependency on `@types/node`, which means (without this change) these types will automatically be available in your app even when some of them should not be available based on the `target` you are using.

### Quick start

Rollup can be used either through a [command line interface](guide/en/#command-line-reference) with an optional configuration file, or else through its [JavaScript API](guide/en/#javascript-api). Run `rollup --help` to see the available options and parameters.
Expand Down

0 comments on commit 7158c06

Please sign in to comment.