Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Unable to provide custom files for generation [BUG]

Ouverte
  • Quelque chose ne va pas ?
#668 1 commentaire 1 réaction 1 personne assignée Voir sur GitHub

@kay-schecker y travaille déjà.

Depuis le 1/11/2022.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

bug

🐛 Bug Report:

Describe the bug

The openapi generator specifies the ability to provide custom files/templates (https://openapi-generator.tech/docs/customization).
This feature does not work with the current version of the CLI.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Install latest version of openapi-generator-cli (currently 5.4.0) npm install [email protected]

  2. Provide the following for the openapitools.json file (note the files keyword), e.g.

    {
    "$schema": "/path/to/schema",
    "generator-cli": {
        "version": "5.4.0",
        "generators": {
             "nodejs": {
                 "templateDir": "#{cwd}/nodejs/templates",
                 "generator-name": "typescript",
                 "output": "#{cwd}/nodejs/sdk",
                 "inputSpec": "#{cwd}/openapi.json",
                 "additionalProperties": {
                    "esTargetVersion": "ES2020",
                    "moduleResolution": "nodejs",
                    "framework": "fetch-api",
                    "platform": "node",
                    "license": "MIT",
                    "useInversify": false,
                    "legacyDiscriminatorBehavior": false
                 },
                 "files": {
                     "api_test.mustache": {
                        "templateType": "ApiTests",
                        "destinationFilename": "spec/api_test.spec.ts"
                     }
                   }
                }
             }
        }
    }
}

  3. Execute the generator
    openapi-generator-cli generate --generator-key nodejs

  4. See error

[[nodejs] #{cwd}/openapi.json] [error] Found unexpected parameters: [--files=api_test.mustache=[object Object]]
[[nodejs] #{cwd}/openapi.json] 
[[nodejs] #{cwd}/openapi.json] See 'openapi-generator-cli help' for usage.

  java -jar "node_modules/@openapitools/openapi-generator-cli/versions/5.4.0.jar" generate
--input-spec="/openapi.json"
--template-dir="/openapi-spec/nodejs/templates"
--generator-name="typescript" 
--output="/nodejs/sdk" 
--additional-properties="esTargetVersion=ES2020,moduleResolution=nodejs,framework=fetch-api,platform=node,license=MIT,useInversify=false,legacyDiscriminatorBehavior=false" 
--files="api_test.mustache=[object Object]" exited with code 1
Expected behavior

the "files" keyword gets resolved properly and all sub-properties are provided to the cli.

Operation System (please complete the following information):
  • OS: MacOS
  • Version 12.6.1
Package System (please complete the following information):
  • Version 5.4.0
Additional context

The typescript generator doesn't ship with a test runtime, so I was in the process of using the customization feature - ran into this instead.

Langage dominant
TypeScript
Étoiles
2k
Forks
210
Merge moyen
7 h
PR mergées (30 j)
3

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-generator-cli

Toutes les issues de OpenAPITools/openapi-generator-cli

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.