asyncapi / asyncapi/generator

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

Open
#1,259 8 comments 0 reactions 0 assignees View on GitHub
enhancement keep-open
Dominant language
JavaScript
Stars
1.1k
Forks
397
Avg merge
1d 7h
Merged PRs (30d)
25

Description

### 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?

- [X] I checked and didn't find a similar issue

### 🏢 Have you read the Contributing Guidelines?

- [X] I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)

### Are you willing to work on this issue?

Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start by reading PR #1177 to locate where the generator's `compile` option default was introduced, then inspect the related option handling and tests. Done means the default is `false` in the next major release while users can still explicitly set `compile: true`; coordinate the change with that release to avoid a breaking change in a minor or patch release.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.