feat: add script to install packages locally in a DXP checkout #98
Conversation
This file contains 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
This is a crude script that will almost certainly have to be evolved as
the shape and structure of the monorepo evolves, but it works for now
with the set of packages that we currently have.
It addresses a bunch of "gotchas" that come with trying to test out
packages with local changes in a liferay-portal checkout. Depending on
which packages you want to test and the dependency graph between them,
you may find that `yarn link` (or even `yarn add`) doesn't do what you
want. Even if you manually copy files (`cp`), things still might not
work because Gradle may decide to re-run a task that ends up blowing
away any changes you make locally under `node_modules`.
At least for the simple case, this script was good enough to allow me to
test:
#97
even though it involved changes to both `eslint-config` and
`npm-scripts`.
As you can see, it does three things:
- Blows away nested `node_modules` folders inside the monorepo, because
`yarn add` can end up copying these over in ways that cause confusion
(broken `bin` links and so on).
- Cleans out the existing versions of the dependencies (in my testing,
removing and then re-adding seemed to produce a cleaner result than
just overwriting).
- Adds the modules to be tested.
Like I said at the start, this is a hack (and not even trying to make it
work on Windows), but it's a useful hack.
|
cc: resident
Fun fact: the high-quality version of that GIF on Giphy is 33 MB. |
|
Need any more duct tape?
|
Not a real review.
|
Review this
|
|
So, I guess I'm just going to merge this wonderful code. |
|
LGTM! 😂 |
wincent
added a commit
that referenced
this pull request
Dec 18, 2020
docs: document "deployFast" (#97)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a crude script that will almost certainly have to be evolved as the shape and structure of the monorepo evolves, but it works for now with the set of packages that we currently have.
It addresses a bunch of "gotchas" that come with trying to test out packages with local changes in a liferay-portal checkout. Depending on which packages you want to test and the dependency graph between them, you may find that
yarn link(or evenyarn add) doesn't do what you want. Even if you manually copy files (cp), things still might not work because Gradle may decide to re-run a task that ends up blowing away any changes you make locally undernode_modules.At least for the simple case, this script was good enough to allow me to test #97, even though it involved changes to both
eslint-configandnpm-scripts.As you can see, it does three things:
node_modulesfolders inside the monorepo, becauseyarn addcan end up copying these over in ways that cause confusion (brokenbinlinks and so on).Like I said at the start, this is a hack (and not even trying to make it work on Windows), but it's a useful hack.