[BUG][typescript-nestjs-server] kebab-case import path of numbered inline model does not match its file name (TS2307)
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 78/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- java, typescript
- Domaine
- backend-api-design, tooling
Piste de recherche
Start with TypeScriptNestjsServerCodegen.toTsImports around line 475 and compare its toModelFilename input with the schema key used to name the generated model file. Reproduce with the supplied spec and fileNaming=kebab-case, then run tsc --noEmit out/models/index.ts. Done when the generated import path matches the model filename and the TypeScript check passes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
Description
In typescript-nestjs-server with fileNaming=kebab-case, the import path of an auto-numbered inline model does not match its file name. A oneOf with two inline object members produces the models OverlapOneOf and OverlapOneOf_1 (class OverlapOneOf1). The file is named from the schema key, but the import is built from the class name, so tsc fails with TS2307.
fileNaming=camelCase is not affected: the file is overlapOneOf1.ts and the import is ./overlapOneOf1.
openapi-generator version
master (e4370ff), 7.28.0-SNAPSHOT. Also seen on 7.26.0.
OpenAPI declaration file content or url
openapi: 3.0.3
info: { title: repro, version: 1.0.0 }
paths:
/overlap:
get:
operationId: getOverlap
responses:
'200':
description: ok
content:
application/json:
schema: { $ref: '#/components/schemas/Overlap' }
components:
schemas:
Overlap:
oneOf:
- type: object
properties:
a: { type: string }
- type: object
properties:
b: { type: integer }
Generation Details
java -jar openapi-generator-cli.jar generate -g typescript-nestjs-server \
-i spec.yaml -o out --additional-properties fileNaming=kebab-case
Steps to reproduce
Generate, then run tsc --noEmit out/models/index.ts.
Actual: the generated files are overlap.ts, overlap-one-of.ts and overlap-one-of-1.ts. out/models/overlap.ts contains:
import { OverlapOneOf1 } from './overlap-one-of1';
models/overlap.ts(2,31): error TS2307: Cannot find module './overlap-one-of1' or its corresponding type declarations.
Expected: the import path matches the file name, e.g. import { OverlapOneOf1 } from './overlap-one-of-1';, or the file is named overlap-one-of1.ts.
Related issues/PRs
#11354 reports the same kind of mismatch for typescript-angular. On current master, typescript-angular names the file from the class name (overlap-one-of1.ts) for this spec, so its import matches.
Suggest a fix
The model file name comes from toModelFilename(<schema key>), giving overlap-one-of-1. The import comes from TypeScriptNestjsServerCodegen.toTsImports (around line 475), which does toModelFilename(removeModelPrefixSuffix(im)) on the class name, giving overlap-one-of1. With kebab-case, dashize(underscore(...)) only splits on _ when it is in the input, so the two paths disagree. Both should derive the file name from the same input.
- Langage dominant
- Java
- Étoiles
- 26.9k
- Forks
- 7.8k
- Merge moyen
- 2 j 23 min
- PR mergées (30 j)
- 177
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OpenAPITools/openapi-generator
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25768 ·
Les mainteneurs répondent en général sous 1 jour
-
Enhancement: Feature
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25753 ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
OpenAPITools/openapi-generator#25724 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25723 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePeut-être pris @Inf1mum l’a pris il y a 2 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25719 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OpenAPITools/openapi-generator
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
eclipse-tradista/tradista#371 ·
Les mainteneurs répondent en général sous 1 jour
-
Failed to start Rescue missionOuvertecritical
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
mars-sim/mars-sim#2199 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
primefaces/primefaces#15568 ·
Les mainteneurs répondent en général sous 1 jour
-
崩溃日志只按 CRLF 分行Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
PCL-Community/PCL-CE#3872 ·
Les mainteneurs répondent en général sous 1 jour