RemiHjson

A Crystal implementation of HJSON based on hjson-go. For other platforms see hjson.org.

HJSON data looks like this:

{
  # specify rate in requests/second (because comments are helpful!)
  rate: 1000

  // prefer c-style comments?
  /* Or C multi-line comments? */

  # did you notice that rate doesn't need quotes?
  hey: look ma, no quotes for strings either!

  # best of all
  notice: []
  anything: ?

  # yes, commas are optional!
}

Wanna support Remilia? Buy me a coffee on Ko-Fi, or support me through Liberapay.

How do I get set up?

You will need Fossil installed to clone this repo. You will also need Shards v0.17.1 or later. If you have an earlier version of Shards, you will need to to build the latest version manually.

Add this to your shard.yml file:

dependencies:
  remihjson:
    fossil: https://chiselapp.com/user/MistressRemilia/repository/remihjson

Usage

TODO: Write usage instructions here

Development

Known Issues

This library is still VERY early in development. While the RemiHjson::Parser class works fine, (de)serialization is still very touchy and may break. Expect the serialization part (RemiHjson::Serializable) to change significantly and slowly match how JSON::Serializable works.

Style info

I use a somewhat non-standard style for my code.

• Keep lines 118 characters or shorter. Obviously sometimes you can't, but please try. Use 80 or 115 characters for Markdown files, though.
• Please use pascalCase for variable and method names. Use CamelCase for type names. Use UPPER_SNAKE_CASE for constants.
• Put parentheses around method parameters, except for these methods: puts, pp, p, raise, sleep, spawn, loop, and exit.
• Always the full do |foo|...end syntax with blocks, except when it's all on one line or an anonymous function, then use { and } or the normal do |foo|...end.
• The type name for exceptions end with Error. For example, ExternalProgramError.

How do I contribute?

1. Go to https://chiselapp.com/user/MistressRemilia/repository/remihjson and clone the Fossil repository.
2. Create a new branch for your feature.
3. Push locally to the new branch.
4. Create a bundle with Fossil that contains your changes.
5. Get in contact with me.

Contributors

• Remilia Scarlet - creator and maintainer
  • Homepage: https://remilia.sdf.org/
  • Mastodon: @MistressRemilia@social.sdf.org
  • Email: zremiliaz@postzeoz.jpz My real address does not contain Z's

Links and Licenses

RemiHjson itself is under the Apache License version 2.0.