feat: make cleanCargoToml customizable #957
Open
+132
−118
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.
Motivation
Currently
cleanCargoTomlhardcodes which paths to remove. This PR allows users to pass apathsModifierfunction tocleanCargoTomlto make it customizable. Further, this PR takes it from a "what to remove" to a "what to keep" approach, which seems more scalable to me. However, this means that it is a breaking change since unknown fields are now removed by default instead of kept by default.This was motivated by me using different cargo-tools that relied in some form or another on fields filtered by
cleanCargoToml(e.g.cargo-leptosusesworkspace.metadata.leptos), which can then be easily adjusted here instead of having to roll my owncleanCargoToml. But could also make it easier to implement #288, I think. I could work on that if this seems like a good direction.There are lib functions which mostly do what my helper functions do, however, these do not handle lists, while my functions do (by iterating over the children and applying the path filtering there too).
Checklist
docs/API.md(or general documentation) with changesCHANGELOG.md