feat: add the main diff function
#30
Conversation
|
@derberg @magicmatatjahu Need your reviews here :) |
|
@aayushmau5 for duplications, please rename sonar config file from |
There was a problem hiding this comment.
just remarks about JSDocs other thank that -> quality code mate!
one more question about
const breaking = 'breaking';
const nonBreaking = 'non-breaking';
const unclassified = 'unclassified';
are these declared in one or multiple places? we need to make sure it is just done once
src/main.ts
Outdated
| * Generates diff between two AsyncAPI documents | ||
| * @param firstDocument The parsed AsycnAPI document | ||
| * @param secondDocument The parsed AsycnAPI document | ||
| * @param {Config} config Configuration options |
There was a problem hiding this comment.
we need more jsdoc details on the configuration options, what options are basically available. Would be good to even include an example like https://github.com/asyncapi/generator/blob/master/lib/generator.js#L144-L165
There was a problem hiding this comment.
like what this override means after all, what is the purpose. What is add, what is remove and what is edit
There was a problem hiding this comment.
yeah, I'm going to add this now. I was working on document generation and JSDoc just gave me Config. I thought it will give things inside them as well 😅
ah, cool. Then I will make a |
|
Wow, that sonar cloud config worked. 🚀 |
|
Kudos, SonarCloud Quality Gate passed!
|
|
🎉 This PR is included in version 0.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This is the PR that bootstraps all other functions. This will the main function which will be responsible for generating the diff.