Skip to content

Commit f58154d

Browse files
committed
docs: clarify clean: true and default include
- 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
1 parent eab48a3 commit f58154d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,17 @@ See [#108](https://github.com/ezolenko/rollup-plugin-typescript2/issues/108)
144144

145145
* `clean`: false
146146

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

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

151-
Path to cache. Defaults to a folder in node_modules.
152+
Path to cache.
153+
Defaults to a folder in `node_modules`.
152154

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

155-
By default passes all .ts files through typescript compiler.
157+
By default compiles all `.ts` and `.tsx` files with TypeScript.
156158

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

0 commit comments

Comments
 (0)