Expose function for encoding YAML events #179
Conversation
yaml/src/Data/Yaml.hs
Outdated
| . (:) EventDocumentStart | ||
| $ objToEvents' o | ||
| $ objToEvents opts o ++ |
There was a problem hiding this comment.
I'd rather not have to lose the difference list approach here. It's not a major performance difference, but it's nice to keep.
yaml/src/Data/Yaml.hs
Outdated
| [ EventDocumentEnd | ||
| , EventStreamEnd | ||
| ] | ||
|
|
||
| -- | Encode a value into YAML 'Event's |
There was a problem hiding this comment.
Please add a @since Haddock comment, as well as a minor version bump and ChangeLog entry.
robbiemcmichael
force-pushed
the
master
branch
from
e622344
to
f7fecb0
Compare
|
@snoyberg Thanks for the review, updated as requested. |
| [ EventDocumentEnd | ||
| , EventStreamEnd | ||
| ] | ||
|
|
||
| -- | Encode a value as YAML 'Event's. |
There was a problem hiding this comment.
Just one more request on the docs: it's a pretty niche use case to need this function. I'd like to see either (or, ideally, both) of:
- Including some explanation in the docs here as to why someone may want this
- Instead of including it in the export list with the more commonly used functions, include it in a separate section for less-commonly-used functions.
There was a problem hiding this comment.
Maybe it would be better for objToEvents (and possibly objToStream) to be moved to the Data.Yaml.Internal module and exported from there since they're both quite low-level.
There also seems to be another function pretty which is doing a very similar job, but this function is also not exported. Unless I'm mistaken, this version can only print strings containing new lines using single quotes so oddly enough it's less pretty than objToEvents.
Is there a reason for both to exist or would you prefer I had a go at refactoring them to use a common function which could be exported from Data.Yaml.Internal?
There was a problem hiding this comment.
Exposing from .Internal and refactoring sounds great, assuming no user-visible behavior changes.
|
Closing this in favour of a new pull request which refactors the code to reduce some of the duplication between |
Exposes `encodeObject` from `Data.Yaml.Internal` to reduce some of the code duplication between the `encode` and `encodePretty` functions. The output of `encodePretty` has changed as a result: - Multiline strings now use `Literal` style instead of `SingleQuoted`. - Special keys are now quoted in maps (resolves snoyberg#179).
I'd like to expose a function for encoding raw YAML events for a project I'm working on. I'm not entirely sure it should be exposed from this module, but happy to refactor if you'd prefer something else.