feat: recursively merge package.json scripts field from build configuration #1372
Conversation
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
kuhe
force-pushed
the
feat/json-deep-merge
branch
3 times, most recently
from
e309140 to
8682531
Compare
kuhe
force-pushed
the
feat/json-deep-merge
branch
from
5b3287a to
fdaadc0
Compare
kstich
reviewed
Aug 28, 2024
| .expectObjectNode(); | ||
|
|
||
| ObjectNode mergedScripts = defaultPackageJson.expectObjectNode("scripts") | ||
| .merge( |
There was a problem hiding this comment.
Is the merge on line 57 not sufficient for this?
There was a problem hiding this comment.
It's a shallow merge, so this does the following:
Default:
{
"name": "A",
"scripts": {
"build": "..."
},
"metadata": "A"
}User supplied:
{
"name": "B",
"scripts": {
"test": "..."
}
}- create the merged
pkg.scriptsobject.
{
"build": "...",
"test": "..."
}- do the normal shallow merge
{
"name": "B",
"scripts": {
"test": "..."
},
"metadata": "A"
}- write the merged
pkg.scriptsonto the shallow merge
{
"name": "B",
"scripts": {
"build": "...",
"test": "..."
},
"metadata": "A"
}
kuhe
force-pushed
the
feat/json-deep-merge
branch
from
fdaadc0 to
6d03588
Compare
|
Aug 28: Need to address CI failures, I think they're related to this PR and not the intermittent kind Oct 7: fixed |
kuhe
force-pushed
the
feat/json-deep-merge
branch
from
6d03588 to
ad64cbd
Compare
kuhe
force-pushed
the
feat/json-deep-merge
branch
from
ad64cbd to
e1fe413
Compare
trivikr
approved these changes
Oct 7, 2024
kstich
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Issue #, if available:
closes #1125
Description of changes:
One of the build options for code generation is:
packageJson| required=No | Custom package.json properties that will be merged with the base package.json. The default value is an empty object.Because of shallow merging, it is difficult for example to merge script entries like
{ "scripts": { "build": "<from codegen>", "test": "<user provided>" } }This PR changes the behavior to recursive merging for only the
scriptsfield. I do not expect anyone to be relying on the existing shallow merge behavior, because every code generated field in"scripts"is there for a reason.More specific customization of the package.json object can be done after the build, if needed.
Recursive merging is not done for other fields, to avoid mixing user and generated nested fields in e.g. authorship metadata or bundler instruction metadata.