Skip to content

Commit

Permalink
docs: clarify the TS option's defaults
Browse files Browse the repository at this point in the history
- "latest 2.x" is no longer accurate and quite outdated (we're on 4.x
  now), so just say it's the peerDep instead
  - @rollup/plugin-typescript calls the default a peerDep too:
    https://github.com/rollup/plugins/tree/master/packages/typescript#typescript

- be more specific that you can pass in a different version or fork of
  TS (like `ttypescript`) through this option
  - follow-up to 8ec49c7

- auto-trim some whitespace-only lines
  - my editor does this automatically, and most of the README has
    trimmed whitespace anyway, so this keeps it consistent
  • Loading branch information
agilgur5 committed May 3, 2022
1 parent 4a69b0d commit 31b4167
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,9 @@ See [#108](https://github.com/ezolenko/rollup-plugin-typescript2/issues/108)
* `rollupCommonJSResolveHack`: false

On windows typescript resolver favors POSIX path, while commonjs plugin (and maybe others?) uses native path as module id. This can result in `namedExports` being ignored if rollup happened to use typescript's resolution. Set to true to pass resolved module path through `resolve()` to match up with `rollup-plugin-commonjs`.

`rollup-plugin-commonjs` fixed this in `10.1.0`, so projects using this option who update to new version will be broken again.

This also works around the similar bug affecting code splitting (see [rollup/issues/3094](https://github.com/rollup/rollup/issues/3094)).

* `objectHashIgnoreUnknownHack`: false
Expand All @@ -168,12 +168,12 @@ See [#108](https://github.com/ezolenko/rollup-plugin-typescript2/issues/108)
* `useTsconfigDeclarationDir`: false

If true, declaration files will be emitted in the directory given in the tsconfig. If false, the declaration files will be placed inside the destination directory given in the Rollup configuration.

Set to false if any other rollup plugins need access to declaration files.

* `typescript`: typescript module installed with the plugin
* `typescript`: peerDependency

When typescript version installed by the plugin (latest 2.x) is unacceptable, you can import your own typescript module and pass it in as `typescript: require("path/to/other/typescript")`. Must be 2.0+, things might break if transpiler interfaces changed enough from what the plugin was built against.
If you'd like to use a different version of TS than the peerDependency, you can import a different TypeScript module and pass it in as `typescript: require("path/to/other/typescript")`. Must be TS 2.0+, things might break if transpiler interfaces changed enough from what the plugin was built against.

* `transformers`: `undefined`

Expand Down

0 comments on commit 31b4167

Please sign in to comment.