Skip to content

Commit

Permalink
docs: add patch-package reference to Customization section (jaredpa…
Browse files Browse the repository at this point in the history
…lmer#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"
  • Loading branch information
agilgur5 authored and paul-vd committed Dec 1, 2020
1 parent 1c30eae commit 5fdec49
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 5fdec49

Please sign in to comment.