Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Circular component import breaks types #5059

Open
gu-stav opened this issue Dec 17, 2024 · 3 comments
Open

Circular component import breaks types #5059

gu-stav opened this issue Dec 17, 2024 · 3 comments
Labels
bug Something isn't working good reproduction ✨ This issue provides a good reproduction, we will be able to investigate it first 🔨 p3-minor-bug

Comments

@gu-stav
Copy link

gu-stav commented Dec 17, 2024

Vue - Official extension or vue-tsc version

2.1.10

VSCode version

2.1.10

Vue version

3.5.13

TypeScript version

5.6.3

System Info

System:
    OS: macOS 15.1.1
    CPU: (12) arm64 Apple M3 Pro
    Memory: 96.86 MB / 18.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 22.3.0 - ~/.nvm/versions/node/v22.3.0/bin/node
    npm: 10.9.2 - ~/.nvm/versions/node/v22.3.0/bin/npm
    pnpm: 8.14.1 - ~/Library/pnpm/pnpm
  Browsers:
    Chrome: 131.0.6778.140
    Edge: 131.0.2903.99
    Firefox Nightly: 135.0a1
    Safari: 18.1.1

package.json dependencies

{
  "dependencies": {
    "radix-vue": "^1.9.11",
    "vue": "^3.5.13",
    "vue-router": "^4.4.5"
  },
  "devDependencies": {
    "@tsconfig/node22": "^22.0.0",
    "@types/jsdom": "^21.1.7",
    "@types/node": "^22.9.3",
    "@vitejs/plugin-vue": "^5.2.1",
    "@vitejs/plugin-vue-jsx": "^4.1.1",
    "@vitest/eslint-plugin": "1.1.10",
    "@vue/eslint-config-prettier": "^10.1.0",
    "@vue/eslint-config-typescript": "^14.1.3",
    "@vue/test-utils": "^2.4.6",
    "@vue/tsconfig": "^0.7.0",
    "eslint": "^9.14.0",
    "eslint-plugin-vue": "^9.30.0",
    "jsdom": "^25.0.1",
    "npm-run-all2": "^7.0.1",
    "prettier": "^3.3.3",
    "typescript": "~5.6.3",
    "vite": "^6.0.1",
    "vite-plugin-vue-devtools": "^7.6.5",
    "vitest": "^2.1.5",
    "vue-tsc": "^2.1.10"
  }
}

Steps to reproduce

  1. Clone + install the attached reproduction (create-vue app)
  2. Navigate to src/components/List.vue

What is expected?

  1. v-model:open="isOpen": isOpen is expected to be of type boolean
  2. emit('branch:click')": emit is expected to be typed

What is actually happening?

  1. isOpen is of type {}
Screenshot 2024-12-17 at 10 13 46
  1. emit is of type {}
Screenshot 2024-12-17 at 10 14 16

Link to minimal reproduction

https://github.com/gu-stav/vue-tsc-circular-reproduction

Any additional comments?

As soon as you remove <Sublist @branch:click="() => emit('branch:click')" />, isOpen is properly typed:

Screenshot 2024-12-17 at 10 15 11

I was not able to reproduce it, but in our app the above works until we upgrade from: "vue-tsc": "^2.1.6", "typescript": "^5.5.4", to "vue-tsc": "^2.1.10", "typescript": "^5.6.3"

@wrong-g
Copy link

wrong-g commented Dec 17, 2024

loop?

@KazariEX KazariEX added bug Something isn't working good reproduction ✨ This issue provides a good reproduction, we will be able to investigate it first 🔨 p3-minor-bug and removed pending triage labels Dec 18, 2024
@KazariEX
Copy link
Collaborator

KazariEX commented Dec 18, 2024

workaround: add a comment node around the root element of the recursively called component's template.

// Sublist.vue
<template>
  <!-- avoid circular reference -->
  <List />
</template>

It will cause references to the root element type to be skipped.

@Acetyld
Copy link

Acetyld commented Dec 18, 2024

Same here, also happens when we do InstanceType in a helper.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good reproduction ✨ This issue provides a good reproduction, we will be able to investigate it first 🔨 p3-minor-bug
Projects
None yet
Development

No branches or pull requests

4 participants