processing-library-template icon indicating copy to clipboard operation
processing-library-template copied to clipboard

fixed escaping characters for library.properties

Open vincentsijben opened this issue 8 months ago • 7 comments

vincentsijben avatar May 15 '25 21:05 vincentsijben

@Stefterv I agree this should be corrected in the contributions repo, but this i still an issue that should be solved here - the library.properties file should not have escaped colons.

mingness avatar May 16 '25 12:05 mingness

Hi @mingness we looked into it, and actually the escaped colon is correct according the .properties specification.

Stefterv avatar May 16 '25 12:05 Stefterv

@Stefterv ok, does it break the process if it's not escaped? if not, maybe now's a good time to make it more intuitive?

mingness avatar May 16 '25 12:05 mingness

@Stefterv actually, which specification are you referring to above? The Processing specification is without the escape: https://github.com/processing/processing4/wiki/Library-Basics#DescribingYourLibrary

mingness avatar May 16 '25 12:05 mingness

The .properties format is defined as part of Java, as described here, where escaping : is technically correct. This is because : can be used interchangeably with =.

Not escaping: doesn't break our pipeline for library.properties files as described in the old Library Basics page (which is probably fine for human-generated properties as it does make it more intuitive) but we should thrive to stick to standards as much as possible when automating things.

SableRaf avatar May 16 '25 13:05 SableRaf

While there is a Processing standard, I would default to that. I'm not clear what further action is necessary other than merging or not merging. I will leave the decision then to you two.

mingness avatar May 16 '25 13:05 mingness

I suggest let's not change standards so easily. The library.properties file has till now not required escaping of colons. Of course we can decide to change that based on reasons, such as a java .properties standard, but let's take some time to think about it. Does this file need to be a java standard properties file? Is user readability important?

mingness avatar May 16 '25 13:05 mingness