fix: augment vue rather than @vue/runtime-core

[danielroe]

Description 描述

For a while, in the Vue ecosystem we've been augmenting @vue/runtime-core to add custom properties and more to vue. However, this inadvertently breaks the types for projects that augment vue - which is (now?) the officially recommended in the docs way to augment these interfaces (for example, ComponentCustomProperties, GlobalComponents and so on).

This means all libraries must update their code (or it will break the types of the libraries that augment vue instead).

Here's an example of how the augmented types end up broken.

This PR is a small effort to ensure the ecosystem is consistent. For context, you can see that vue-router has moved to do this, as well as Nuxt.

Linked Issues 关联的 Issues

Additional context 额外上下文

Summary by CodeRabbit

• New Features

  • Updated the import method for the AButton component to improve compatibility within the Vue.js environment.
  • Changed the module reference from '@vue/runtime-core' to 'vue' across the codebase, enhancing module import management.

• Bug Fixes

  • Resolved potential issues with component rendering on the H5 platform.

• Documentation

  • Updated README.md to reflect changes in module declarations and component imports.

[coderabbitai]

Walkthrough

The recent changes streamline the TypeScript module declarations for Vue.js components, improving how components like AButton are imported. By shifting from referencing @vue/runtime-core to vue, the updates enhance compatibility and simplify the module structure. This ensures consistent usage of components across the application, particularly benefiting third-party integrations and H5 platform rendering.

Changes

File	Change Summary
README.md, playground/components.d.ts, test/dts.test.ts	Updated module declaration from @vue/runtime-core to vue, simplifying component imports. The AButton component's import changed from named to default export without altering the component declarations.

Poem

In the meadow where code blooms bright,
AButton hops to the left and right.
With Vue's warm embrace, it finds its place,
Simplified paths, a joyful space!
H5 dreams now take their flight,
A rabbit's cheer for code so light! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b88677 and 7ba8117.

Files ignored due to path filters (1)

• test/__snapshots__/dts.test.ts.snap is excluded by !**/*.snap

Files selected for processing (3)

• README.md (1 hunks)
• playground/components.d.ts (1 hunks)
• test/dts.test.ts (4 hunks)

Additional comments not posted (3)

playground/components.d.ts (1)

10-10: Correct module augmentation for Vue.

Changing the module declaration from '@vue/runtime-core' to 'vue' aligns with Vue's recommended practices. This change should help maintain type integrity and improve compatibility across different libraries.

README.md (1)

Line range hint 10-14: Ensure correct usage of default exports.

Updating the import statements to use the default export for AButton and UniCalendar aligns with best practices for module imports in TypeScript. This change should improve compatibility and resolve potential issues with component rendering.

test/dts.test.ts (1)

55-55: Correct module augmentation for Vue in tests.

Changing the module declaration from '@vue/runtime-core' to 'vue' in the test files aligns with Vue's recommended practices. This change should help maintain type integrity and improve compatibility across different libraries.

Also applies to: 135-135, 158-158, 181-181

[ModyQyW]

Thank you. I Will release it later.