[BUG][typescript-nestjs-server] kebab-case import path of numbered inline model does not match its file name (TS2307)
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 78/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- java, typescript
- Lĩnh vực
- backend-api-design, tooling
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Java
- Star
- 26.9k
- Fork
- 7.8k
- Merge trung bình
- 2 ngày 23 phút
- Pull request đã merge (30 ngày)
- 177
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của OpenAPITools/openapi-generator
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Enhancement: Feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorCó thể đã có người làm @Inf1mum đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
OpenAPITools/openapi-generator#25724 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayCó thể đã có người làm @Inf1mum đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
OpenAPITools/openapi-generator#25723 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twiceCó thể đã có người làm @Inf1mum đã nhận 2 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
OpenAPITools/openapi-generator#25719 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của OpenAPITools/openapi-generator
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
eclipse-tradista/tradista#371 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Failed to start Rescue missionĐang mởcritical
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
mars-sim/mars-sim#2199 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
primefaces/primefaces#15568 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
崩溃日志只按 CRLF 分行Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
PCL-Community/PCL-CE#3872 ·
Maintainer thường phản hồi trong vòng 1 ngày