Skip to content

Commit

Permalink
(docs): add warning to tsdx.config.js usage (#400)
Browse files Browse the repository at this point in the history
- similar to the ones that exist in react-app-rewired and customize-cra
  as, like CRA, changing TSDX internals is a fragile path
  • Loading branch information
agilgur5 authored and swyxio committed Jan 2, 2020
1 parent 158ee9a commit 35fa947
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,9 @@ _TODO: Simple guide to host error codes to be completed_

### Rollup

> **❗⚠️❗ Warning**: <br>
> These modifications will override the default behavior and configuration of TSDX. As such they can invalidate internal guarantees and assumptions. These types of changes can break internal behavior and can be very fragile against updates. Use with discretion!
TSDX uses Rollup under the hood. The defaults are solid for most packages (Formik uses the defaults!). However, if you do wish to alter the rollup configuration, you can do so by creating a file called `tsdx.config.js` at the root of your project like so:

```js
Expand Down

0 comments on commit 35fa947

Please sign in to comment.