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

When building the ES library in lib mode, JSDoc is missing and props pointing is incorrect. #12160

Open
China-xiaoFang opened this issue Oct 13, 2024 · 0 comments

Comments

@China-xiaoFang
Copy link

Vue version

3.5.12

Link to minimal reproduction

https://stackblitz.com/edit/props-jsdoc-error-20241013

Steps to reproduce

Step 1: pnpm install
Step 2: pnpm build
Step 3: Move the .d.ts file in fast-element-plus/types/packages to the fast-element-plus/es folder.
Step 4: Copy packages/components/dialog/index.d.ts to the fast-element-plus/es/components/dialog folder.
If you get the code directly, you can ignore the above four steps.

Steps to reproduce:
You can install the fast-element-plus package through npm or install it through local files. (There is a complete example in the app folder)
In vs code, hovering the mouse over the disabledConfirmButton property does not display comments.
When I use Crtl + left click to view the definition, it is automatically defined to a place without comments. The strange thing is that this property is commented in all other places in the entire .d.ts file, but there is no comment here by default.

What is expected?

I hope vs code can prompt the comments of props attributes.

What is actually happening?

I don't understand whether it is a problem with vs code or a problem with my library building that causes the jsdoc comments of my props to not display properly, but through the .d.ts file, I can see that there are indeed jsdoc comments in many places.
This is extremely inefficient for me to customize the component library for developers to use without documentation.

System Info

System:
    OS: Windows 11 10.0.22631
    CPU: (20) x64 12th Gen Intel(R) Core(TM) i7-12700
    Memory: 15.20 GB / 31.79 GB
  Binaries:
    Node: 20.15.0 - C:\Program Files\nodejs\node.EXE
    npm: 10.7.0 - C:\Program Files\nodejs\npm.CMD
    pnpm: 9.11.0 - C:\Program Files\nodejs\pnpm.CMD
  Browsers:
    Edge: Chromium (129.0.2792.65)
    Internet Explorer: 11.0.22621.3527

Any additional comments?

No response

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

No branches or pull requests

1 participant