Skip to content

Commit

Permalink
docs: clarify clean: true and default include
Browse files Browse the repository at this point in the history
- the docs for `clean` don't seem to have been updated with 15cb84dcc99a0bd20f3afce101c0991683010b6, which slightly changed how it works
- also clarify that "wipes out cache" means it deletes _all_ previous caches by saying "wipes any existing cache" instead

- fix the `include` default explanation to mention `.tsx` files as well, since the regex includes those
  - also add code backticks and capitalize TypeScript etc (guess I missed this option in my previous PRs? or I intentionally left it as a separate change a while ago...)

- also add code backticks around `node_modules` in `cacheRoot` as well while at it

- use non-rendered newlines between sentences for markdown style consistency
  • Loading branch information
agilgur5 committed Jul 20, 2022
1 parent eab48a3 commit f58154d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,17 @@ See [#108](https://github.com/ezolenko/rollup-plugin-typescript2/issues/108)

* `clean`: false

Set to true for clean build (wipes out cache on every build).
Set to true to disable the cache and do a clean build.
This also wipes any existing cache.

* `cacheRoot`: `node_modules/.cache/rollup-plugin-typescript2`

Path to cache. Defaults to a folder in node_modules.
Path to cache.
Defaults to a folder in `node_modules`.

* `include`: `[ "*.ts+(|x)", "**/*.ts+(|x)" ]`

By default passes all .ts files through typescript compiler.
By default compiles all `.ts` and `.tsx` files with TypeScript.

* `exclude`: `[ "*.d.ts", "**/*.d.ts" ]`

Expand Down

0 comments on commit f58154d

Please sign in to comment.