Use the same structure for Blueprint JSON definitions and step handlers - #215
Merged
Merged
Conversation
Member
|
Really appreciate the cross-platform harmonization of calling convention here. That can go pretty far to bridging any gaps between the different environments. |
Collaborator
Author
|
I'm glad you like it @dmsnell! I just pushed an update that refactors all the steps, I wonder if you can see any possible improvements there |
adamziel
commented
Apr 25, 2023
adamziel
marked this pull request as ready for review
April 25, 2023 17:27
Collaborator
Author
|
Let's merge this one. I'm happy to apply any feedback as a follow-up PR. |
This was referenced Apr 26, 2023
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
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.
Description
This Pull Request proposes a change in the structure of Blueprint JSON definitions and step handlers to make them consistent with each other.
In the current implementation, there is a discrepancy between how steps are defined in the Blueprint JSON and how their corresponding handlers are defined. While the Blueprint step definition includes the step name and its associated parameters, the handler function directly accepts the parameters without any reference to the step name. This lack of consistency can lead to confusion and errors while developing and maintaining the Blueprint.
This PR refactors step handler functions to accept parameters as an object that maps one to one with the related JSON structure. It also reuses the same TypeScript types. This makes the code more intuitive and less error-prone by providing a clear mapping between the step definitions and their corresponding handlers.
Before
After