feat: enable string input for generate

[jonaslagoni]

Description
This feature was driven by the following problems that needed to be fixed:

• In feat: add Parser-API version 2 support #1017 I did not know that CLI used generateFromString instead of generate, and that was not changed at all.
• generateFromString parses the document with the old parser, and that means it cannot understand v3 documents.

Changes:

• generateFromString is being deprecated and generate should be used instead.
• generate now handles string inputs and parses the document according to the template configuration apiVersion
• validateTemplateConfig now accesses the server object according to the parser API

Related issue(s)
Fixes #1038

[jonaslagoni]

I cant for the life of me disable or ignore the sonar cloud issues. If anyone knows how do let me know..

[derberg]

in case of sonar, just remove these NOSONAR comments and modify https://github.com/asyncapi/generator/blob/master/.sonarcloud.properties

just exclude all tests like test/**/*

for cognitive complexity, put this before the function /* eslint-disable sonarjs/cognitive-complexity */

---

also please adjust title, it is a feat imho because of deprecation. So write what you change and not what you fix

[jonaslagoni]

for cognitive complexity, put this before the function /* eslint-disable sonarjs/cognitive-complexity */

This is not respected by sonar.

just exclude all tests like test/**/*

Added 👍

also please adjust title, it is a feat imho because of deprecation. So write what you change and not what you fix

Alright 👍

[derberg]

@jonaslagoni chatGPT wrote it is possible to add sonar.cpd.cognitivecomplexity.threshold=20 to .sonarcloud.properties

[jonaslagoni]

@derberg yea but that will just increase global threshold, not really ignoring single function 😅

[derberg]

@jonaslagoni which is ok right? better just increase threshold, and then we should worry when we go beyond, and see what we can do, rather than just silent forever?

[jonaslagoni]

@jonaslagoni which is ok right? better just increase threshold, and then we should worry when we go beyond, and see what we can do, rather than just silent forever?

I guess 😄 Updated it.

[derberg]

looks like chatGPT lied 😅 yeah, remove the fake setting (including // eslint-disable-next-line sonarjs/cognitive-complexity) and open a followup good first issue to solve complexity issue - and let us merge

[jonaslagoni]

looks like chatGPT lied 😅 yeah, remove the fake setting (including // eslint-disable-next-line sonarjs/cognitive-complexity) and open a followup good first issue to solve complexity issue - and let us merge

Had to leave the eslint-disable-next-line as otherwise our linting tool would complain.

Did a quick test with the HTML template re-write just to make sure everything still worked as expected with v3 documents. And found a problem with tests and implementation.

@derberg should be all ready for the final review now ✌️

[derberg]

Did you check with other templates, that are not yet migrated, like for example nodejs-template

I'm getting:

# running from local from fix_v3_support branch
$ ./cli.js https://bit.ly/asyncapi @asyncapi/nodejs-template -p server=production -o lolo --force-write
Something went wrong:
TypeError [ERR_INVALID_ARG_TYPE]: The "data" argument must be of type string or an instance of Buffer, TypedArray, or DataView. Received undefined
    at Object.writeFileSync (node:fs:2146:5)
    at createAsyncapiFile (/Users/xxx/generator/node_modules/@asyncapi/generator-hooks/src/index.js:28:6)
    at /Users/xxx/generator/lib/generator.js:827:20
    at Array.map (<anonymous>)
    at Generator.launchHook (/Users/xxx/generator/lib/generator.js:824:28)
    at Generator.generate (/Users/xxx/generator/lib/generator.js:208:18)
    at async /Users/xxx/generator/cli.js:159:9

[derberg]

error comes from at createAsyncapiFile (/Users/xxx/generator/node_modules/@asyncapi/generator-hooks/src/index.js:28:6)

console log in the location

  console.log('dupa', asyncapi)
  fs.writeFileSync(asyncapiOutputLocation, asyncapi);

returns undefined

asyncapi variable comes from const asyncapi = generator.originalAsyncAPI;

and yeah, I checked, generator no longer provides originalAsyncAPI

[jonaslagoni]

@derberg not sure why I removed it 🤔

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[jonaslagoni]

Fixed it and added it to the tests

[derberg]

lgtm! 🚀

will you create the followup for cognitive stuff or want me to?

[jonaslagoni]

will you create the followup for cognitive stuff or want me to?

If you got time please do 👍 Heading over to the templates right now to fix the remaining stuff so they are ready to be reviewed as well.

[jonaslagoni]

Thanks @derberg 👍

[jonaslagoni]

/rtm

[derberg]

done #1040

[asyncapi-bot]

🎉 This PR is included in version 1.13.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀