feat: add support for configurable hooks libraries

[derberg]

Description

• generate:before and others become a hook type. Hook name is the name of hook function. you do not have to always provide it but it is a must have for hooks libararies and you enable a hook by referring it's name
• Way of writing hook function changed. register function is no longer needed as part of the hook which enables easier testing. You write a regular functon and expose it grouped by hook type:

module.exports = {
  "generate:after": [myHook1, myHook2],
  "generate:before": myHook3
}

• hooks registration extracted to separate js file and local hooks traversing refactored to use xfs for async walking as we use in other parts of the generator
• test and docs
• I tried to have more sophisticated tests for hooks registration where I can test different scenarios when passing different configs with errors or not but I think I'm too stupid to do it with jest. I wasted a few hours trying to mock files with modules that could be used in the registration but first I stumbled upon an issue with xfs that didn't work well with mock-fs. Then with quick refactor to stop using xfs in favor of klaw things were getting better but this would require larger refactor to kind out xfs from the project.

MIGRATION PATHS
This PR is a breaking change and you need to adjust your templates hooks, if you have one. There are 2 paths to follow here:

• path where you have one hook that was always with us in AsyncAPI, to save processed asyncapi file in generated output. You just need to remove it and configure template to use our hooks library -> feat: use external hooks repo to not duplicate code asyncapi-archived-repos/nodejs-template#13
• path where you need to refactor your hooks to follow new way of hooks registration -> feat: migrate to latest generator enabling usage of reusable hooks asyncapi-archived-repos/java-spring-template#35

Related issue(s)
See also #318

[Tenischev]

Will it be better to provide upper in example section at least one hook with defined name?

[derberg]

What do you mean? in example section we provide examples of hooks that you rather put locally in your template, writing own hooks library is like advanced usage in my opinion

this config example shows usage of our official hooks library, you do not have to add to config your local hooks

[Tenischev]

Yes, but assume i'm newbie. I just read Hooks section, now read this section and see specify exact name of the hook. And now i ask, what exactly hook name is? This has not been mentioned before.
So, sure, you do not need to give names to local hooks, but example of hook with name will increase understanding of the concept, from my point of view.

[derberg]

how about now? I added some more content 87a9dfd

[Tenischev]

I still think that one example is better than long description 😄 , but nevertheless questions are described now in docs. So it's fine.

[fmvilas]

Looks good. Just left a suggestion and agree with @Tenischev comments but overall looks great.

Regarding tests, I think we should introduce integration (snapshot maybe) tests for these features, would be easier than doing unit tests. Not now though.

[Tenischev]

I still think that one example is better than long description 😄 , but nevertheless questions are described now in docs. So it's fine.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.0% Duplication

[asyncapi-bot]

🎉 This PR is included in version 0.46.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀