From 35fa947e49a49a21627653a1f76c6a1e22d9e0ab Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Wed, 1 Jan 2020 22:30:58 -0500 Subject: [PATCH] (docs): add warning to tsdx.config.js usage (#400) - similar to the ones that exist in react-app-rewired and customize-cra as, like CRA, changing TSDX internals is a fragile path --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 44edbb69f..e6d4ebd08 100644 --- a/README.md +++ b/README.md @@ -299,6 +299,9 @@ _TODO: Simple guide to host error codes to be completed_ ### Rollup +> **❗⚠️❗ Warning**:
+> 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