yamlfmt: added and implemented functional features #43
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
While adding functionality for small edge cases or formatting differences, I found that the Formatter code was becoming harder to reason about. It would grow linearly with the number of little formatting things I had to do. I have adjusted the pattern to instead be a collection of functional features that can be added at-will. Created a new `Feature` type that has a Before and After action. Also added the FeatureList type, with code to apply the before or after actions in order on byte slice input. I converted all existing candidates in the formatter code to use this functional feature pattern instead.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
|
This is me under my personal account (I made the fixes on my personal computer while I don't have access to my work one). |
This wraps feature apply errors with the name and type of action.
Instead of a receiver method that configures the features in place on the formatter, make it so the features are returned from a function that reads the config. Avoids deliberate mutability.
braydonk
approved these changes
Sep 10, 2022
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.
While adding functionality for small edge cases or formatting differences, I found that the Formatter code was becoming harder to reason about. It would grow linearly with the number of little formatting things I had to do. I have adjusted the pattern to instead be a collection of functional features that can be added at-will.
Created a new
Featuretype that has a Before and After action. Also added the FeatureList type, with code to apply the before or after actions in order on byte slice input.I converted all existing candidates in the formatter code to use this functional feature pattern instead.