feat!: use CSVWriter interface instead of csv.Writer in SafeCSVWriter #233
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
BREAKING CHANGE: it is no longer possible to access and modify underlying properties (such as Comma) of csv.Writer from a SafeCSVWriter instance.
|
Hi, as I don't use this library I'm not sure if this breaking change will impact a lot of people or not, I would like some feedback from other users if you don't mind 🙂 |
|
Howdy @gfaugere ! I was just about to create a fork to do exactly this. While you may have been relatively new to Go in January of last year, I'll go as far as to say that the only thing that would hold me back from merging this (if I had that capability) would be changes to the documentation and examples. From a usability standpoint, I don't even see this as a breaking change, really. In my mind, it seems like modifying the delimiter that your CSV writer uses in-situ is a pretty bad idea from the jump, so this would truly make it a Safe CSVWriter 😁 |
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.
Using the interface instead of the encoding/csv.Writer allows users to use truly custom writers, or to add their own wrappers in the writer chain.
We have a use case where we want to transform our fields before writing, and allowing us to wrap the writer while keeping the lib provided SafeCSVWriter would be quite cool!
This is a breaking change as it changes the contract of type SafeCSVWriter (props from the csv.Writer can no longer be accessed from it), but I think it would be better to decouple these two?
Let me know if you think there is any downside to this? I don't see any but I am quite new with Go