[BUG][typescript-nestjs-server] kebab-case import path of numbered inline model does not match its file name (TS2307)
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 78/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- java, typescript
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Java
- スター
- 26.9k
- フォーク
- 7.8k
- 平均マージ
- 2日 23分
- マージ済み PR(30日)
- 177
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-generator のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
OpenAPITools/openapi-generator#25768 ·
メンテナーはふだん 1 日以内に返信
-
Enhancement: Feature
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
OpenAPITools/openapi-generator#25753 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodError対応中かも @Inf1mum が 3 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
OpenAPITools/openapi-generator#25724 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an Array対応中かも @Inf1mum が 3 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
OpenAPITools/openapi-generator#25723 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twice対応中かも @Inf1mum が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
OpenAPITools/openapi-generator#25719 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
OpenAPITools/openapi-generator の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
eclipse-tradista/tradista#371 ·
メンテナーはふだん 1 日以内に返信
-
critical
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
mars-sim/mars-sim#2199 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
primefaces/primefaces#15568 ·
メンテナーはふだん 1 日以内に返信
-
崩溃日志只按 CRLF 分行オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
PCL-Community/PCL-CE#3872 ·
メンテナーはふだん 1 日以内に返信