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

[FEATURE] JSON5 support for integration config files #1680

Closed
Swiddis opened this issue Apr 9, 2024 · 3 comments
Closed

[FEATURE] JSON5 support for integration config files #1680

Swiddis opened this issue Apr 9, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers integrations Used to denote items related to the Integrations project

Comments

@Swiddis
Copy link
Collaborator

Swiddis commented Apr 9, 2024

Is your feature request related to a problem?
JSON5 is an extension of JSON that makes it easier for humans to work with, for scenarios like config files. Among other things this includes:

  • Comments
  • No need to quote keys
  • Multiline strings
  • Trailing comma support

Integrations currently uses JSON to store all of its config data, which isn't terrible but also isn't ideal.

What solution would you like?
It would be nice to support JSON5 for integration config files, since these are typically written by hand by integration developers.

What alternatives have you considered?
We could use alternative formats like TOML or YAML, but that seems like a more drastic change. It probably wouldn't be a massive migration since we could have backwards-compatible JSON support, but it would be more complex and require maintaining both serializations. JSON5 is a more drop-in replacement that still has some nice ease-of-use additions.

Do you have any additional context?
Marking this as "Good First Issue" since most of the work is replacing the import in the Integration file reader and Integration JSON reader, give or take some more CTRL+F for JSON.parse refs.

@Swiddis Swiddis added enhancement New feature or request good first issue Good for newcomers labels Apr 9, 2024
@Swiddis Swiddis added integrations Used to denote items related to the Integrations project and removed untriaged labels Apr 9, 2024
@devesh-2002
Copy link
Contributor

May I take up this issue?

@Swiddis
Copy link
Collaborator Author

Swiddis commented Apr 16, 2024

By all means! Feel free to ask any questions here as well.

@Swiddis
Copy link
Collaborator Author

Swiddis commented May 2, 2024

Completed by #1732

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers integrations Used to denote items related to the Integrations project
Projects
None yet
Development

No branches or pull requests

2 participants