search

Charcoal-SE / SmokeDetector-ng

SmokeDetector reboot project.
Apache License 2.0
6 stars 3 forks source link

config.json and rooms.json need sample versions #28

Closed AWegnerGitHub closed 7 years ago

AWegnerGitHub commented 7 years ago

Both config.json and rooms.json need to be pulled out of the repository and replaced with *.sample.json versions (like secrets.json).

Doing this allows individual instances to update configuration and room settings without worrying about those settings being clobbered when they update from the repository.

With this change, config.json and rooms.json will need to be ignored.

quartata commented 7 years ago

The current ones basically are sample versions. I'll just rename them (and add some comments).

quartata commented 7 years ago

Tried to find a JSON module that supported comments, but it doesn't seem to work on Python 3...

j-f1 commented 7 years ago

@quartata json5 or hjson?

quartata commented 7 years ago

Oh, cool. I'll look into it later.

ArtOfCode- commented 7 years ago

JSON doesn't have comments...

quartata commented 7 years ago

Not standard JSON obviously. But variants do (+ this new JSON 5 thing apparently)

ferrybig commented 7 years ago

If we are going to use "JSON with comments", it's not JSON anymore, so we require all implementations that have the potential to read these "json" files to support the custom standard. This is bad for future maintainability of the code

Manishearth commented 7 years ago

TOML is "json with comments". It's a superset of json which supports list-style data and comments.