feat: support files listed in nonRenderableFiles with conditionalFiles

[derberg]

Description

• nonRenderableFiles are also supported by conditionalFiles.
• extend some details in authoring.md

Related issue(s)
Resolves #358

[derberg]

@fmvilas

I added support for nonrenderablefiles as agreed in the related issue

I tested against:

"nonRenderableFiles": [
      "src/api/middlewares/*.*",
      "src/lib/config.js"
    ],
    "conditionalFiles": {
      "src/lib/config.js": {
        "subject": "server.protocol",
        "validation": {
          "const": "amqp"
        }
      }
    }

and works as expected, src/lib/config.js is not getting through

ready for review

[Tenischev]

@derberg i do not agree that this will resolve #358
First of all, example of "subject": "server.protocol", is not sufficient since there is no hint that every time when you wish to generate template, in the fact, you must specify server paramter otherwise conditionalFiles will no work.

[derberg]

@Tenischev it is not yet merged, so for sure it doesn't resolve yet. But the goal is that it does 😉

First of all, example of "subject": "server.protocol", is not sufficient since there is no hint that every time when you wish to generate template, in the fact, you must specify server paramter otherwise conditionalFiles will no work.

• there are 2 examples now
• descriptions of server param is enriched

Do you like it 😄
If not I need some hints on how to make you happy 😄

[Tenischev]

I ❤️ new server parameter description 👏 😄

But there still issue about these

if subject is not resolved in AsyncAPI, then file will be rendered because of this condition

[derberg]

@Tenischev oh, I know what you mean, that actually sucks, you are right, in this new example I added about info.contact, if entire contact is not provided, support.html doc will be created

so I made a fix but to fix it nice there would have to be a nice log message. But we have too many of those already, so I added another use case to our new debug flag.

example of log messages for different cases, where there is debug on or off

$ ./cli.js ../nodejs-template/asyncapi.yml ../nodejs-template -o output --force-write -p server=dummy-mqtt --debug
docs/support.html was not generated because info.contact specified in template configuration in conditionalFiles was not found in provided AsyncAPI specification file

Done! ✨
Check out your shiny new generated files at /Users/wookiee/Documents/sources/generator/output.

$ ./cli.js ../nodejs-template/asyncapi.yml ../nodejs-template -o output --force-write -p server=dummy-mqtt --debug

docs/support.html was not generated because condition specified for this file in template configuration in conditionalFiles matched

Done! ✨
Check out your shiny new generated files at /Users/wookiee/Documents/sources/generator/output.

$ ./cli.js ../nodejs-template/asyncapi.yml ../nodejs-template -o output --force-write -p server=dummy-mqtt


Done! ✨
Check out your shiny new generated files at /Users/wookiee/Documents/sources/generator/output.

[Tenischev]

Without template in the beginning, because of

generator/lib/generator.js

Line 546 in 736bfa0

const relativeSourceFile = path.relative(this.templateContentDir, sourceFile);

[Tenischev]

Without template in the beginning, because of

generator/lib/generator.js

Line 546 in 736bfa0

const relativeSourceFile = path.relative(this.templateContentDir, sourceFile);

[derberg]

ok, I think I made it a bit too confusing, I meant here in example that path must be relative to template dir. I'll fix

[Tenischev]

Nice idea! Could we pass debug flag into template? So in template we also could write some debug logs. (Ofc this suggestion is for separate issue)

[derberg]

you for sure have access to it in hooks out of the box, but filters and Nunjucks, that would be awesome, please write an issue for it

[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

[derberg]

@Tenischev how about 1c0dccd

[Tenischev]

Very good fix! Thanks!

[asyncapi-bot]

🎉 This PR is included in version 0.52.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀