OpenAPITools/openapi-generator

[REQ][php] declareStrictTypes option for all PHP generators

Open

#12,771 opened on Jul 5, 2022

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)batch import
Client: PHPEnhancement: FeatureGood First IssueServer: PHP

Description

Is your feature request related to a problem? Please describe.

Usually I totally against codegen options which modifies one line of code, but this one looks really handy.

Describe the solution you'd like

Add declareStrictTypes switch option to AbstractPhpCodegen class, then:

openapi-generator-cli generate -g php --additional-properties=declareStrictTypes=true \
    -o out -i petstore.yaml

then in all mustache files:

<?php 

{{#declareStrictTypes}}declare(strict_types=1);{{/declareStrictTypes}}

We also need to decide whether this switch option should be on or off by default. I think it should be on, but it can cause breaking changes.

Describe alternatives you've considered

Close this issue as not necessary feature 😆

Additional context

cc @jebentier @dkarlovi @mandrean @jfastnacht @renepardon

Contributor guide

Tech stack
phpjava
Domain
apitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Mustache templatesPHPJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the AbstractPhpCodegen class in the Java codebase to understand how options are added to code generators. Examine existing PHP mustache templates to identify where declare(strict types=1) should be inserted. Check the issue comments for any discussion on the default value and potential breaking changes. Consider reaching out to maintainers for guidance on whether the option should be enabled by default.