Allow partial configs in environment overrides #1026
Merged
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
Fix the TypeScript types so that you don't have to do a full set of config keys in environment overrides
jpage-godaddy
commented
Jan 31, 2025
| @@ -118,7 +118,7 @@ createCommand.action = async function run(appname, options, command) { | |||
|
|
|||
| const pluginGasket = makeGasket({ | |||
| ...context.presetConfig, | |||
| plugins: context.presets.concat(context.presetConfig.plugins) | |||
| plugins: context.presetConfig.plugins.concat(context.presets) | |||
There was a problem hiding this comment.
This is just an annoying limitation of TypeScript. Because context.presets is of type Array<Plugin> it cannot concatenate in Array<Plugin | { default: Plugin }> because concat is defined such where the return value is supposed to be the same as the original array. However, it can do this in the reverse order. I assume that the order of plugins doesn't matter.
jpage-godaddy
commented
Jan 31, 2025
| @@ -38,7 +38,7 @@ export class Gasket { | |||
| // prune nullish and/or empty plugins | |||
| config.plugins = config.plugins | |||
| .filter(Boolean) | |||
| .map(plugin => plugin.default || plugin) // quality of life for cjs apps | |||
| .map(plugin => 'default' in plugin ? plugin.default : plugin) // quality of life for cjs apps | |||
There was a problem hiding this comment.
TypeScript is able to use an in check to narrow a type; seeing if a default property is falsy doesn't do the same, so the old expression wasn't able to be resolved as a Plugin object.
mmason2-godaddy
approved these changes
Jan 31, 2025
agerard-godaddy
approved these changes
Jan 31, 2025
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.
Summary
Fix the TypeScript types so that you don't have to do a full set of config keys in environment overrides to avoid TypeScript errors.
Changelog
Test Plan
Added type test