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

Better error messages for generators when failing to write to catalog. #839

Open
boyney123 opened this issue Oct 3, 2024 · 0 comments
Open
Labels

Comments

@boyney123
Copy link
Collaborator

Use Case

When the generator tries to write a value that is undefined to the catalog, the YML module under the hood will give error messages like this

Processing 1 AsyncAPI files...
Processing C:\Users\ivangsa\workspace\EDALearn\EDA-Playground-Online-Food-Delivery\modules\orders\src\main\resources\apis\asyncapi.yml

Processing domain: Orders (v0.0.1)
 - Domain (v0.0.1) created
Error loading plugin: YAMLException: unacceptable kind of an object to dump [object Undefined]
    at writeNode (C:\Users\ivangsa\workspace\EDALearn\EDA-Playground-Online-Food-Delivery\event-catalog\node_modules\gray-matter\node_modules\js-yaml\lib\js-yaml\dumper.js:779:13)
....
}

It would be more useful to give error message that make more sense.

Proposed Solution

No response

Implementation Notes

No response

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant