From 5fdec491f3199f5b27c99f716c8b4c3325caa704 Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Wed, 9 Sep 2020 14:39:56 -0400 Subject: [PATCH] docs: add `patch-package` reference to Customization section (#855) - for when you need to make some small changes to the internal code and forking is a bit too extreme of an option - hopefully patch-package means folks get their changes in faster without waiting for PRs and means folks don't have to use outdated forks etc - it was first recommended by Shawn in issues then strongly recommended by Jared and I've recommended it a few times too for smaller changes - Quoting Jared: "Yes, to documenting patch-package as ultimate escape hatch" --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 7ca1ca4e8..7600ec32c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Despite all the recent hype, setting up a new TypeScript (x React) library can b - [Babel](#babel) - [Jest](#jest) - [ESLint](#eslint) + - [`patch-package`](#patch-package) - [Inspiration](#inspiration) - [Comparison with Microbundle](#comparison-with-microbundle) - [API Reference](#api-reference) @@ -388,6 +389,11 @@ You can add your own `jest.config.js` to the root of your project and TSDX will You can add your own `.eslintrc.js` to the root of your project and TSDX will **deep merge** it with [its own ESLint config](./src/createEslintConfig.ts). +### `patch-package` + +If you still need more customizations, we recommend using [`patch-package`](https://github.com/ds300/patch-package) so you don't need to fork. +Keep in mind that these types of changes may be quite fragile against version updates. + ## Inspiration TSDX was originally ripped out of [Formik's](https://github.com/jaredpalmer/formik) build tooling.