Skip to content

[REQ] Avoid warning in typescript client generator #20485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SimoneDalka opened this issue Jan 16, 2025 · 5 comments · Fixed by #21012
Closed

[REQ] Avoid warning in typescript client generator #20485

SimoneDalka opened this issue Jan 16, 2025 · 5 comments · Fixed by #21012

Comments

@SimoneDalka
Copy link
Contributor

SimoneDalka commented Jan 16, 2025

When I try to generate a typescript client setting only --input-spec and --output parameters, openapi-generator-cli prompts a warning with the following message:

[main] WARN  o.o.codegen.DefaultCodegen - The value (generator's option) must be either boolean or string. Default to `false`.

Describe the solution you'd like

Check if the supportsES6 additional property is present before trying to set it inside processOpts() method of AbstractTypeScriptClientCodegen class:

if (additionalProperties.containsKey(CodegenConstants.SUPPORTS_ES6)) {
    setSupportsES6(convertPropertyToBooleanAndWriteBack(CodegenConstants.SUPPORTS_ES6));
}

or

convertPropertyToBooleanAndWriteBack(CodegenConstants.SUPPORTS_ES6, this::setSupportsES6);

Describe alternatives you've considered

In order to make the warning disappear, I have to explicitly set supportsES6 additional property:

openapi-generator-cli generate -g typescript-angular [...] -p supportsES6=false

Additional context

The warning is produced by convertPropertyToBooleanAndWriteBack method inside setSupportsES6 setter:

@SimoneDalka SimoneDalka changed the title [REQ] Avoid wanring in typescript client generator [REQ] Avoid warning in typescript client generator Jan 16, 2025
@DManstrator
Copy link

I stumbled upon the exact same problem. However I saw that there is #16187 which completely removes it. So I guess it makes no sense to file a PR for this, does it?

@SimoneDalka
Copy link
Contributor Author

I found the same line of code is the master branch, so I think the warning will still be present:

Am I wrong?

Despite this, It's only a minor change to avoid a warning: I wouldn't create a dedicated PR, we can wait for the next changes planned on that generator.

@DManstrator
Copy link

I'm not sure if I understand you correctly. The PR I linked will remove that line (see 8636efe#diff-e07b04e9dd1e4acea6c1d994fd38512f06fa272ca70e4bca3e8d9126e74e5ca0), so after it was merged, it won't be in the master branch anymore.

Due to that, creating a PR for this issue would lead to Merge Conflicts in the other PR. However, the linked PR is stale for 1.5 years now and even it's just a warning, it should be treated properly as you proposed in your description.

So feel free to create a PR for it. :D

@SimoneDalka
Copy link
Contributor Author

Sorry, I thought they had already merged the PR...

@wing328 are you planning to merge that PR or is it still on hold?

Thanks

@wing328
Copy link
Member

wing328 commented Apr 2, 2025

please see the update: #16187 (comment)

please open a PR with your suggested fix for the warning message when you've time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants