https://github.com/chanced/transcode

a markup language conversion library for go
https://github.com/chanced/transcode

go golang json yaml

Last synced: about 1 month ago
JSON representation

a markup language conversion library for go

• Host: GitHub
• URL: https://github.com/chanced/transcode
• Owner: chanced
• License: mit
• Created: 2022-09-08T13:54:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T14:51:44.000Z (over 3 years ago)
• Last Synced: 2024-10-06T00:42:37.574Z (over 1 year ago)
• Topics: go, golang, json, yaml
• Language: Go
• Homepage:
• Size: 46.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# transcode is markup language conversion library

[![Go Reference](https://pkg.go.dev/badge/github.com/chanced/transcode.svg)](https://pkg.go.dev/github.com/chanced/transcode)

transcode is a go library that will convert markup languages (currently JSON and YAML) from one form to another.

## Motivation

While it is possible to decode JSON as YAML, doing so comes with caveats. YAML

is a superset of JSON and so unmarshaling a YAML object into `interface{}` will

result in `map[interface{}]interface{}`. When you need to work with the raw data

or would like to work with JSON Schema, this can be problematic.

Encoding JSON as YAML is easily accomplishable with standard tooling. However,

this library will be faster than unmarshaling JSON as `interface{}`, and then

remarshaling as YAML. It also provides some very minimal formatting.

There are some drawbacks to using transcode though:

-   YAML aliases are not supported

-   All keys remain strings when transcoding into YAML

-   YAML comments are obviously lost

## License

MIT