feat(config): preserve comments in the static analysis configuration file - IDE-2599 #472
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
robertohuertasm
changed the title
robertohuertasm
force-pushed
the
rob/feat/preserve-comments
branch
2 times, most recently
from
e68729c to
43e9bcf
Compare
jacobotb
reviewed
Jul 31, 2024
...rc/bin/datadog_static_analyzer_server/ide/configuration_file/comment_preserver/reconciler.rs
Outdated
Show resolved
Hide resolved
…ails avoid map_err
robertohuertasm
force-pushed
the
rob/feat/preserve-comments
branch
from
c699c3e to
b61e46c
Compare
jacobotb
approved these changes
Jul 31, 2024
Co-authored-by: Jacobo Tarrío <158186053+jacobotb@users.noreply.github.com>
albertvaka
reviewed
Jul 31, 2024
...rc/bin/datadog_static_analyzer_server/ide/configuration_file/comment_preserver/reconciler.rs
Show resolved
Hide resolved
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.
What problem are you trying to solve?
The main problem is that the comments of the configuration file are removed after modification due to the deserialization and serialization process. Some users have complained about it.
What is your solution?
Added support for comment preservation and pretty formatting.
Alternatives considered
What the reviewer should know
The last commit fixes some
clippywarnings that were triggering when committing or pushing (via cargo-husky). I had to touch some files outside theidefolder. For some reason, we're using-D warningslocally but not in the CI. I didn't want to modify any of this but I guess it would be nice to reconcile this difference at some point.preserving_comments_in_rust.mp4
IDE-2599