[BUG][typescript-nestjs-server] kebab-case import path of numbered inline model does not match its file name (TS2307)
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- java, typescript
- Área
- backend-api-design, tooling
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Java
- Estrellas
- 26.9k
- Forks
- 7.8k
- Merge medio
- 2 d 23 min
- PR fusionados (30 d)
- 177
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OpenAPITools/openapi-generator
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25768 ·
Los mantenedores suelen responder en 1 día
-
Enhancement: Feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25753 ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPosiblemente ocupada @Inf1mum la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
OpenAPITools/openapi-generator#25724 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPosiblemente ocupada @Inf1mum la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25723 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePosiblemente ocupada @Inf1mum la tomó hace 2 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25719 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de OpenAPITools/openapi-generator
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
eclipse-tradista/tradista#371 ·
Los mantenedores suelen responder en 1 día
-
Failed to start Rescue missionAbiertocritical
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
mars-sim/mars-sim#2199 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
primefaces/primefaces#15568 ·
Los mantenedores suelen responder en 1 día
-
崩溃日志只按 CRLF 分行Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
PCL-Community/PCL-CE#3872 ·
Los mantenedores suelen responder en 1 día