Fix Record<string, never> appearing in discriminator union #1248
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: d233633 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
drwpow
force-pushed
the
no-empty-object-union
branch
from
11e4fcf to
69fc7ef
Compare
Deploying with
|
| Latest commit: |
d233633
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c96ff172.openapi-ts.pages.dev |
| Branch Preview URL: | https://no-empty-object-union.openapi-ts.pages.dev |
drwpow
force-pushed
the
no-empty-object-union
branch
from
69fc7ef to
358c55c
Compare
drwpow
commented
Jul 25, 2023
| @@ -4,8 +4,8 @@ module.exports = { | |||
| parserOptions: { | |||
| project: ["./tsconfig.json"], | |||
| }, | |||
| extends: ["eslint:recommended", "plugin:@typescript-eslint/strict"], | |||
| plugins: ["@typescript-eslint", "prettier"], | |||
| extends: ["eslint:recommended", "plugin:@typescript-eslint/strict", "plugin:vitest/recommended"], | |||
There was a problem hiding this comment.
Minor linting improvements to test files (mostly just catches test.only() from lingering, which can be easy to forget to remove)
drwpow
force-pushed
the
no-empty-object-union
branch
from
358c55c to
f86107d
Compare
drwpow
commented
Jul 25, 2023
| @@ -34143,7 +34143,7 @@ export interface components { | |||
| public?: boolean; | |||
| /** Format: uri-template */ | |||
| pulls_url: string; | |||
| pushed_at: number | string; | |||
| pushed_at: number | string | null; | |||
drwpow
commented
Jul 25, 2023
| @@ -73010,7 +73010,7 @@ export interface components { | |||
| files?: string[]; | |||
| bin?: Record<string, never>; | |||
| man?: Record<string, never>; | |||
| directories?: string | Record<string, never>; | |||
| directories?: string | Record<string, never> | null; | |||
There was a problem hiding this comment.
This seems wrong, but is generated from:
oneOf:
- type: string
- type: object
nullable: trueThis is correct, at least as long as we generate Record<string, never> for empty objects (with no additionaalProperties)
drwpow
force-pushed
the
no-empty-object-union
branch
from
f86107d to
5d11dea
Compare
drwpow
force-pushed
the
no-empty-object-union
branch
from
5d11dea to
d233633
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
If a discriminator has
type: "object"in it, it would completely change the output.Unfortunately, fixing this did cause some⚠️ minor breaking changes in generated types. But I’m hopeful the change is an improvement and not a regression, as the new types should yield better TS inference.
How to Review
Tests should pass.
Checklist
examples/directory updated (only applicable for openapi-typescript)