Configuration files
LoIDE is designed to allow configuration via JSON files. The rules on how these files are to be written are defined in the JSON Schema. Using an open source tool (json-schema-form-humans), human-friendly documentation was generated from these JSON schemas.
There are two JSON configuration files:
Consideration about notation:
- In the documentation properties that are preceded by the symbol
+are mandatory, while those preceded by the symbol-are optional.
The json-schema-form-humans library was used to generate the Markdown documentation featured in this wiki. Follow the instructions on installation and execution in the project repository. The jsfh-conf.yaml configuration file contained in the project root was used to generate the documentation on LoIDE's JSON schemas.
Once the library is installed, run the following commands from the project root:
generate-schema-doc --config-file jsfh-conf.yaml config/app-config-schema.json app-config-schema-doc.md
generate-schema-doc --config-file jsfh-conf.yaml config/services-schema.json services-schema-doc.md
These will create two files (app-config-schema-doc.md and services-schema-doc.md) that contain human readable documentation.
In this case not using properties such as "deprecated" and "definition," the following command is used to remove these columns from the documentation.
sed -E -i 's/\| Deprecated \| Definition |\| ---------- \| ---------- |\| No \| - //' app-config-schema-doc.md
sed -E -i 's/\| Deprecated \| Definition |\| ---------- \| ---------- |\| No \| - //' services-schema-doc.md