Skip to content
This repository has been archived by the owner on Apr 28, 2020. It is now read-only.

Rolling TODO List #1

Open
4 tasks
jordanbtucker opened this issue Mar 31, 2016 · 1 comment
Open
4 tasks

Rolling TODO List #1

jordanbtucker opened this issue Mar 31, 2016 · 1 comment

Comments

@jordanbtucker
Copy link
Member

v1.0.0 (TODO list not yet finalized)

  • Write public API. (The public API doesn't do anything right now. All working code is in non-exported functions.)
  • Write tests. (I'm not even sure if this works yet. I translated it from the json5-net implementation.)
  • Document everything.
  • Determine whether the package or repository needs to be renamed. (Import path github.com/jordanbtucker/json5-go exports package json5. See Organizing Go code.)
@mewmew
Copy link

mewmew commented Sep 2, 2019

Consider exporting the same API as encoding/json in the Go standard library. Since json5 is a superset of JSON, this would allow users to seamlessly start using json5 without having to change anything in their programs except the import path.

In particular, it would be great to have access to MarshalIndent for having JSON5 pretty-printed in a canonical fashion.

It would also be good to have NewEncoder and NewDecoder. so users of the API may use arbitrary io.Reader and io.Writer values.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants