[BUG][typescript-nestjs-server] kebab-case import path of numbered inline model does not match its file name (TS2307)
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 78/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- java, typescript
- Domain
- backend-api-design, tooling
Research direction
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.
Written by the indexing model from the issue text.
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.
- Dominant language
- Java
- Stars
- 26.9k
- Forks
- 7.8k
- Avg merge
- 2d 23m
- Merged PRs (30d)
- 177
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenAPITools/openapi-generator
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainers usually reply within 1 day
-
Enhancement: Feature
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
OpenAPITools/openapi-generator#25724 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25723 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25719 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenAPITools/openapi-generator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
primefaces/primefaces#15568 ·
Maintainers usually reply within 1 day
-
崩溃日志只按 CRLF 分行Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PCL-Community/PCL-CE#3872 ·
Maintainers usually reply within 1 day