asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
767 stars 232 forks source link

[FEATURE]: Make `compile` option default to `false` in future major release #1259

Open Gmin2 opened 2 months ago

Gmin2 commented 2 months ago

Why do we need this improvement?

In PR #1177, we introduced the compile option in the generator and set its default value to true. This was implemented to ensure that transpilation runs by default

However, our initial plan was to have transpilation disabled by default, with an option to enable it when needed. In our next major release, we should change the default value of the compile option back to false to align with our initial plan.

This change should be implemented as part of our next major version release to avoid introducing a breaking change in a minor or patch release.

How will this change help?

This change will have transpilation disabled by default, with an option to enable it when needed. Users who rely on the current behavior will need to explicitly set compile: true after upgrading to the new major version.

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

derberg commented 2 months ago

this has to be done together with additional documentation that explains the compilation/transpilation concept + explanation on how to publish a template with transpilation files included -> https://github.com/asyncapi/html-template/pull/575

TheMarvelFan commented 3 days ago

@derberg @Gmin2

Is anyone working on this issue?

Gmin2 commented 2 days ago

Is anyone working on this issue?

This issue is mostly completed only, we need to make depreciating notice, feel free to pick other issues