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

Support formats with comments for migration files #281

Open
KholdStare opened this issue Feb 7, 2024 · 2 comments
Open

Support formats with comments for migration files #281

KholdStare opened this issue Feb 7, 2024 · 2 comments

Comments

@KholdStare
Copy link

Currently JSON is the only format supported for migration files. It would be nice to have a format that supports comments. Yaml is common even if it has its drawbacks. Since Yaml is a superset of json, every json file should also be a valid yaml file, but can also include comments.

@exekias
Copy link
Member

exekias commented Feb 8, 2024

Thank you for opening this issue! it could be nice to support other formats like YAML. My only concern would be around portability, having a common format for everyone makes it easier to document & share knowledge between users.

That said, parsing migration files into the Migration object is a rather thin layer in the CLI, so it may be ok & easy enough to allow other formats.

@KholdStare
Copy link
Author

Another option could be jsonnet? https://jsonnet.org/

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