Skip to content

Commit

Permalink
(docs): async plugins are now supported out-of-the-box (#205)
Browse files Browse the repository at this point in the history
- so remove that reference to objectHashIgnoreUnknownHack

- also be more specific about what cases objectHashIgnoreUnknownHack
  might be needed for
  - asyncgeneratorfunctions are still one off the top of my head, but
    there are certainly others it just won't know about, including
    future syntaxes
  • Loading branch information
agilgur5 authored Feb 13, 2020
1 parent e957a89 commit 0caa1c4
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,6 @@ Must be before rollup-plugin-typescript2 in the plugin list, especially when `br

See explanation for `rollupCommonJSResolveHack` option below.

#### plugins using async/await

See `objectHashIgnoreUnknownHack` below.

#### rollup-plugin-babel

This plugin transpiles code, but doesn't change file extension. Babel plugin, even though it claims it processes all files, only looks at code with those extensions by default: `.js,.jsx,.es6,.es,.mjs`. To workaround add `ts` and `tsx` to the list of babel extensions.
Expand Down Expand Up @@ -168,7 +164,7 @@ See [#108](https://github.com/ezolenko/rollup-plugin-typescript2/issues/108)

* `objectHashIgnoreUnknownHack`: false

The plugin uses rollup config as part of cache key. `object-hash` is used to generate a hash, but it can't hash certain elements at the moment. Setting this option to true will make `object-hash` ignore unknowns, at the cost of not invalidating the cache if ignored elements are changed. Only enable this if you need it and make sure to run with `clean: true` once in a while and definitely before a release. (See [#105](https://github.com/ezolenko/rollup-plugin-typescript2/issues/105) and [#203](https://github.com/ezolenko/rollup-plugin-typescript2/pull/203))
The plugin uses rollup config as part of cache key. `object-hash` is used to generate a hash, but it can have trouble with some uncommon types of elements. Setting this option to true will make `object-hash` ignore unknowns, at the cost of not invalidating the cache if ignored elements are changed. Only enable this if you need it (`Error: Unknown object type "xxx"` for example) and make sure to run with `clean: true` once in a while and definitely before a release. (See [#105](https://github.com/ezolenko/rollup-plugin-typescript2/issues/105) and [#203](https://github.com/ezolenko/rollup-plugin-typescript2/pull/203))

* `useTsconfigDeclarationDir`: false

Expand Down

0 comments on commit 0caa1c4

Please sign in to comment.