(docs): add warning to tsdx.config.js usage#400
Merged
swyxio merged 1 commit intojaredpalmer:masterfrom Jan 2, 2020
Merged
Conversation
Collaborator
Author
|
Oook, here's another example of tests randomly failing on existing code in a PR that doesn't change any source code (only docs). Seems related to errors I was getting in #397 (comment) and #367 (comment) . It didn't seem like they were race conditions, but now I'm not sure if this is just filesystem unreliability either given how frequently it's occurred. Not sure what to do about it 😕 |
jaredpalmer
requested changes
Dec 29, 2019
- similar to the ones that exist in react-app-rewired and customize-cra as, like CRA, changing TSDX internals is a fragile path
agilgur5
force-pushed
the
tsdx-config-warning
branch
from
85f82a4 to
10a1058
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
as, like CRA, changing TSDX internals is a fragile path
Related to #389 (comment) , #379 . This escape hatch is being used quite a bit by TSDX users as seen in various issues, but I'm not sure if all are aware of the risks that inherently entails (as I detailed in #389 (comment)). Those risks should be more explicit, as this may catch users off-guard, especially during updates, as even a patch update could break usage inside
tsdx.config.js.Plugins could at least pin a peer dependency and update when their own tests pass for newer versions, but ad-hoc code is more brittle than that. Notably, Razzle does support plugins, and those are listed as the first option before modifying
webpackconfig directly (rollupfor TSDX)Probably makes sense to leave this to @jaredpalmer as Razzle doesn't quite have the same language.