Skip to content

[typescript-fetch] Support fileNaming option (#18283)#18284

Merged
macjohnny merged 3 commits intoOpenAPITools:masterfrom
En0s0und:ts-fetch-fileNamingOpt
May 3, 2024
Merged

[typescript-fetch] Support fileNaming option (#18283)#18284
macjohnny merged 3 commits intoOpenAPITools:masterfrom
En0s0und:ts-fetch-fileNamingOpt

Conversation

@En0s0und
Copy link
Copy Markdown
Contributor

@En0s0und En0s0und commented Apr 3, 2024

Description

Add new option "fileNaming" for the typescript-fetch generator with following eligible values :

  • PascalCase (default)
  • camelCase
  • kebab-case

That option already exists in typescript-angular and typescript-nestjs generators.

fixes: #18283
Original PR for typescript-angular generator: #727

To validate

You can save the following specs in a file called test-spec.yaml

openapi: 3.0.0
info:
  version: 1.0.0
  title: Example for fileNaming option
paths:
  /pet:
    get:
      tags:
        - pet-controller
      operationId: getPet
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
components:
  schemas:
    PetCategory:
      properties:
        id:
          type: integer
    Pet:
      properties:
        id:
          type: integer
        category:
          $ref: '#/components/schemas/PetCategory'

Then run following commands

java -jar openapi-generator-cli.jar generate -i test-spec.yaml -g typescript-fetch -o in-PascalCase

java -jar openapi-generator-cli.jar generate -i test-spec.yaml -g typescript-fetch -o in-kebab-case --additional-properties "fileNaming=kebab-case"

java -jar openapi-generator-cli.jar generate -i test-spec.yaml -g typescript-fetch -o in-camelCase --additional-properties "fileNaming=camelCase"

File names must have the wanted format for each case and those file names must be used in imports.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@En0s0und En0s0und force-pushed the ts-fetch-fileNamingOpt branch from c8d3e55 to d1996a3 Compare April 3, 2024 15:36
@En0s0und En0s0und marked this pull request as ready for review April 4, 2024 10:30
*/
private String convertUsingFileNamingConvention(String originalName) {
String name = originalName;
if ("kebab-case".equals(fileNaming)) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please introduce constants and use them in all changed lines

Copy link
Copy Markdown
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall,
Thanks for your contribution!
Please also resolve the merge conflict

@En0s0und En0s0und force-pushed the ts-fetch-fileNamingOpt branch from e0601af to 5a2457a Compare April 29, 2024 08:18
@En0s0und
Copy link
Copy Markdown
Contributor Author

Thanks for the code review ! Constants had been introduced and conflict resolved.

@macjohnny macjohnny merged commit 0e809d4 into OpenAPITools:master May 3, 2024
@wing328 wing328 added this to the 7.6.0 milestone May 20, 2024
@En0s0und En0s0und deleted the ts-fetch-fileNamingOpt branch May 21, 2024 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ][typescript-fetch] Generate file names in kebab-case

3 participants