Remove onChanges() method in ResourceYaml.vue
#12800
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
This removes the `onChanges()` method from `ResourceYaml.vue` because the intent of the code is not clear and appears to provide no benefit in testing. This is a source of frustration for some users, making it impossible to add comments to YAML. It appears that this function exists to automatically adjust the indentation of comment lines; it has failed to accomplish this task during testing, so it appears to be meaningless. If users wish to format yaml, we should support this with an explicit action in the YAML editor, not something that is performed on every keypress. Signed-off-by: Phillip Rak <rak.phillip@gmail.com>
codyrancher
approved these changes
Dec 5, 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.
Summary
This removes the
onChanges()method fromResourceYaml.vuebecause the intent of the code is not clear and appears to provide no benefit in testing. This is a source of frustration for some users, making it impossible to add comments to YAML.It appears that this function exists to automatically adjust the indentation of comment lines; it has failed to accomplish this task during testing. If users wish to format yaml, we should support this with an explicit action in the YAML editor, not something that is performed on every keypress.
Fixes #11226
Occurred changes and/or fixed issues
onChanges()method fromResourceYaml.vueTechnical notes summary
Areas or cases that should be tested
YAML editors throughout Dashboard: we want to make sure that we can edit, delete, and create lines. Ensure that Copy/Paste works. Make sure that no regressions arise as a result of this change, especially in scenarios related to indenting and comments.
Areas which could experience regressions
YAML Editor
Screenshot/Video
Before
2024-12-04.15-33-39.mp4
After
2024-12-04.17-02-25.mp4
Checklist