OpenAPITools / OpenAPITools/openapi-generator

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

Open
#12,771 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: PHP Enhancement: Feature Good First Issue Server: PHP
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the AbstractPhpCodegen class and then inspect the PHP mustache files used by the generators. Trace how additional properties are exposed to templates, determine the default for declareStrictTypes, and verify that the option consistently controls the strict-types declaration across the relevant generated PHP files.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.