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 comments in MongoDB migrations #1108

Open
bart1024 opened this issue Jun 10, 2024 · 0 comments
Open

Support comments in MongoDB migrations #1108

bart1024 opened this issue Jun 10, 2024 · 0 comments

Comments

@bart1024
Copy link

Is your feature request related to a problem? Please describe.
Code comments are a basic feature present in every programming language. MongoDB migrations are written in JSON format. That's why one can't simply write comments to make the migration code more readable. It might be super handy to provide some context, examples, and notes for a complex migration script.

Describe the solution you'd like
Support JSON extension like JSONC or JSON5.

Describe alternatives you've considered

  • adding $comment to the migration query. It's not that convenient (e.g. long multi-line descriptions will look ugly)
  • writing migrations in JSONC and convert to JSON files before applying.

Additional context

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

1 participant