Skip to content

incorrect generated library.properties #88

Open
@vincentsijben

Description

@vincentsijben
Contributor

Describe the bug

When using the gradle task "writeLibraryProperties", the : sign is escaped with an \ . So this

# List of authors. Links can be provided using the syntax [author name](url).
authors=[Vincent Sijben](https://github.com/vincentsijben)

# A web page for your Library, NOT a direct link to where to download it.
url=https://vincentsijben.github.io/vjmotion-processing/

ends up being this in library.properties

authors=[Vincent Sijben](https\://github.com/vincentsijben)
url=https\://vincentsijben.github.io/vjmotion-processing/

which in turn causes the link in the contribution manager to fail.

Activity

SableRaf

SableRaf commented on May 15, 2025

@SableRaf
Collaborator

Hi @vincentsijben and thanks for your report!

Would you be interested in submitting a PR for a fix? I’d be happy to provide guidance if needed.

vincentsijben

vincentsijben commented on May 15, 2025

@vincentsijben
ContributorAuthor

#89

I had to ask chatGPT 🤣

SableRaf

SableRaf commented on May 16, 2025

@SableRaf
Collaborator

Hi @vincentsijben and thanks for your efforts!

@Stefterv and I looked into this further. Escaping the : character is part of the .properties specification. The actual issue is with the scripts/parse_and_validate_properties_txt.py script in the processing-contributions repo. I created an issue about this over there: processing/processing-contributions#76

mingness

mingness commented on May 16, 2025

@mingness
Collaborator

@vincentsijben thanks for reporting this and the quick fix!
@SableRaf @Stefterv thanks for delving deeper into the effect, and the cause of it.

mingness

mingness commented on May 17, 2025

@mingness
Collaborator

I've made changes to the processing-contributions repo that should fix the linking issue.

First, I manually removed the backslashes - the contributions.yaml file is only updated when the version is updated, so it wouldn't automatically remove the backslashes until the next update.

Second, the parsing function reads in property text files as Java property files, with the additional parsing of inline comments. Inline comments are present in many property text files, but are not treated as such in Java property files. These comments are present to clarify the formatting version numbers, so without this additional parse step, the version numbers would contain the hash and comments.

Anyway, any new libraries won't introduce the backslash-colon into urls in the contributions.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @SableRaf@mingness@vincentsijben

      Issue actions

        incorrect generated library.properties · Issue #88 · processing/processing-library-template