Skip to content

incorrect generated library.properties #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
vincentsijben opened this issue May 14, 2025 · 5 comments · May be fixed by #89
Open

incorrect generated library.properties #88

vincentsijben opened this issue May 14, 2025 · 5 comments · May be fixed by #89
Labels
bug Something isn't working

Comments

@vincentsijben
Copy link
Contributor

vincentsijben commented May 14, 2025 •
edited
Loading

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.
@vincentsijben vincentsijben added the bug Something isn't working label May 14, 2025
@SableRaf
Copy link
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
Copy link
Contributor Author

#89

I had to ask chatGPT 🤣

@SableRaf
Copy link
Collaborator

SableRaf commented May 16, 2025 •
edited
Loading

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

@SableRaf SableRaf mentioned this issue May 16, 2025
Closed
@mingness
Copy link
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 linked a pull request May 16, 2025 that will close this issue
fixed escaping characters for library.properties #89
Draft
@mingness
Copy link
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
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fixed escaping characters for library.properties vincentsijben/processing-library-template
3 participants
@SableRaf @mingness @vincentsijben