Start a new topic

Make RDFE format more readable for source control

The RDFE file format is used for Royal TS Dynamic Folder Exports, and is based on the JSON file format. Among other things, the source code of the script backing the dynamic folder is included as part of this Json file, as a single long string.


The problem is that when this is then checked into source code, the scripts become checked in as a single very long line, which makes it impractical to directly read the script by inspecting the RDFE file, something that's useful to be able to do for example when reviewing different versions of the RDFE file in source control.


Example: https://github.com/royalapplications/toolbox/blob/808a0f8af0e1a78a162288f149ed7560ff18883e/Dynamic%20Folder/1Password/1Password%20(Python).rdfe#L71


It would therefore be a good idea of the file format were modified somehow so that the actual source code with one line in the RDFE file representing one line source code, and even better if the source code could be presented mostly verbatim in the RDFE file.


This could of course be acheived in many ways.

Doing it with JSON is not possible, directly, since the JSON format doesn't have any proviso for multiline strings. The best you can do is store the code line by line in an array instead of in a large string, but this is a breaking format change.

If you're going to do a breaking format you might as well do something a little more radical.

For example, XML might offer a solution? The script source code could be then included in a CDATA section, which would make the source code directly readable as part of this new RDFE file format.

1 person likes this idea
1 Comment

We are looking at possible solutions as this is also bugging us ;)


2 people like this
Login or Signup to post a comment