NEW: @W-17293079@: Update ConfigDescription objects to include type and default value information #143
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
…nd default value information
stephen-carter-at-sf
force-pushed
the
sc/W-17293079
branch
from
4d6c071 to
d0acac4
Compare
jfeingold35
reviewed
Dec 3, 2024
| // Every engine config should have an overview, so if missing, then we add in a generic one | ||
| if (!engineConfigDescription.overview) { | ||
| engineConfigDescription.overview = getMessage('GenericEngineConfigOverview', engineName.toUpperCase()); | ||
| function normalizeEngineConfigDescription(engineConfigDescription: engApi.ConfigDescription, engineName: string, |
Contributor
There was a problem hiding this comment.
Tiny nitpick: Since this method returns a new object now instead of modifying the provided one, could we rename it toNormalized... instead of normalize...?
Contributor
Author
There was a problem hiding this comment.
How about fromEngineConfigDescription or toConfigDescription instead since we are now converting an engApi.ConfigDescription to a ConfigDescription?
Contributor
Author
There was a problem hiding this comment.
Pushed a commit to call this toConfigDescription and added in a comment to make it clear.
jfeingold35
approved these changes
Dec 3, 2024
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 work will allow us to then update our cli client making it far easier and more robust to detect default values, types, etc.