Skip to content

fix(types): correct import of types#4003

Merged
antfu merged 2 commits intomainfrom
type-imports
Jun 28, 2021
Merged

fix(types): correct import of types#4003
antfu merged 2 commits intomainfrom
type-imports

Conversation

@GrygrFlzr
Copy link
Copy Markdown
Member

Description

Fixes #4002.

d.ts files are treated as an ambient module declarations only if they don't have any imports. If you provide an import line, it's now treated as a normal module file, not the global one, so augmenting modules definitions doesn't work.

Thus, the addition of imports in the client.d.ts in #3638:

import {
  ErrorPayload,
  FullReloadPayload,
  PrunePayload,
  UpdatePayload
} from 'types/hmrPayload'

Is improper and invalidates client.d.ts as an ambient declaration.

Instead, we have to import types this way:

(
  event: 'vite:beforeUpdate',
  cb: (payload: import('./types/hmrPayload').UpdatePayload) => void
): void

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@patak-cat
Copy link
Copy Markdown
Member

@GrygrFlzr for the rest of the types, we are duplicating the definitions instead of importing them. I am fine if this is a better approach and we start moving towards using imports, but if we plan to leave things as is, shouldn't we duplicate also these definitions to be consistent? Or is there something different from these ones in particular?

@GrygrFlzr
Copy link
Copy Markdown
Member Author

As suggested, I've swapped to consistently importing in order to remove the duplicated types. CustomEventName has been extracted out into its own file. This also fixes a missing import.meta.env.SSR property in client.d.ts.

@IanVS
Copy link
Copy Markdown
Contributor

IanVS commented Jun 28, 2021

I copied these changes into my node_modules, and my type errors have disappeared. Seems to indeed fix #4002. Thanks!

@patak-cat patak-cat requested a review from antfu June 28, 2021 18:46
@antfu antfu merged commit 4954636 into main Jun 28, 2021
@antfu antfu deleted the type-imports branch June 28, 2021 20:35
aleclarson pushed a commit to aleclarson/vite that referenced this pull request Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[2.4.0-beta.0] New typescript errors for css and import.meta.env

4 participants