Skip to content
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.

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

Refactor config panel logic using yq instead of sed #131

Open
thardev opened this issue Jan 29, 2024 · 2 comments
Open

Refactor config panel logic using yq instead of sed #131

thardev opened this issue Jan 29, 2024 · 2 comments

Comments

@thardev
Copy link
Collaborator

thardev commented Jan 29, 2024

Context

When the config panel was implemented, sed was mainly used for setter and getter logic. Since the config file is a YAML file, yq should be used for better maintainability, simplicity and compatibility.

Probably yq should be included as Yunohost core dependency. An issue is being tracker here:
YunoHost/issues#2146

@Gredin67
Copy link
Collaborator

IMHO we should wait the switch to bookworm to merge yq in the master branches. Meanwhile we can prepare yq branches, or as said elsewhere, have two main mautrix_go and mautrix_python repos (with yq) from which the other bridges will be forked. We can install yq locally in our development environments.

Regarding yq, I think it is fine to erase comments on lines that are exposed in the config panel. Because we are already explaining them there anyway. But we should keep the comments around settings that are not exposed.

@thardev
Copy link
Collaborator Author

thardev commented Feb 1, 2024

Hi @Gredin67

I agree with you, that seems like the best scenario and a good idea to fork from those generic repos.
Regarding the comments, yes, that is fine for me. 🙂
I'll keep this open to keep track of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants