refactor: generate function refactored to reduce cognitive complexity #1047
Conversation
swastiksuvam55
requested review from
derberg,
magicmatatjahu,
jonaslagoni and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
lib/generator.js
Outdated
| @@ -160,7 +160,7 @@ class Generator { | |||
| * @return {Promise} | |||
| */ | |||
| // eslint-disable-next-line sonarjs/cognitive-complexity | |||
| async generate(asyncapiDocument, parseOptions = {}) { | |||
| /* async generate(asyncapiDocument, parseOptions = {}) { | |||
There was a problem hiding this comment.
Please remove any commented out code 🙂
|
You also have a linting issue 🙂 |
|
@jonaslagoni Thank you for the much-needed feedback, I've made the changes can you please review it again? |
lib/generator.js
Outdated
| @@ -136,67 +136,174 @@ class Generator { | |||
| }); | |||
| } | |||
|
|
|||
| // eslint-disable-next-line sonarjs/cognitive-complexity | |||
lib/generator.js
Outdated
| */ | ||
| // eslint-disable-next-line sonarjs/cognitive-complexity | ||
|
|
There was a problem hiding this comment.
No new lines between the jsdoc and function 🙂
lib/generator.js
Outdated
| * generator | ||
| * .generate(myAsyncAPIdocument) | ||
| * .then(() => { | ||
| * console.log('Done!'); | ||
| * }) | ||
| * .catch(console.error); | ||
| * | ||
| * @example <caption>Using async/await</caption> | ||
| * try { | ||
| * await generator.generate(myAsyncAPIdocument); | ||
| * console.log('Done!'); | ||
| * } catch (e) { | ||
| * console.error(e); | ||
| * } |
There was a problem hiding this comment.
You can leave the different examples, no need to remove it 🙂
lib/generator.js
Outdated
|
|
||
| // Setup the output based on the configured options |
lib/generator.js
Outdated
| /** | ||
| * Installs and sets up the template for code generation. | ||
| * | ||
| * This function installs the specified template using the provided installation option, | ||
| * sets up the necessary directory paths, loads the template configuration, and returns | ||
| * information about the installed template. | ||
| * | ||
| * @async | ||
| * @returns {Promise<{ templatePkgName: string, templatePkgPath: string }>} | ||
| * A promise that resolves to an object containing the name and path of the installed template. | ||
| */ |
lib/generator.js
Outdated
| /** | ||
| * Executes the 'generate:after' hook. | ||
| * | ||
| * Launches the after-hook to perform additional actions after code generation. | ||
| * | ||
| * @async | ||
| * @returns {Promise<void>} A promise that resolves when the after-hook execution is completed. | ||
| */ |
|
Kudos, SonarCloud Quality Gate passed!
|
|
/rtm |
|
@all-contributors please add @swastiksuvam55 for code |
|
I've put up a pull request to add @swastiksuvam55! 🎉 |
|
🎉 This PR is included in version 1.14.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
generatefunction refactored to smaller individual functions to reduce cognitive complexityRelated issue(s):
Fixes #1040