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

feat(mobile): optimize the common package name on mobile devices #2775

Closed
wants to merge 1 commit into from

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Jan 10, 2025

PR

优化移动common包名称和引入路径,完善依赖添加xss依赖

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Based on the comprehensive summary, here are the release notes:

  • Module Refactoring

    • Updated import paths from @mobile-root/vue-common to @mobile-root/common across multiple components
    • Standardized module imports for Vue component definitions
  • Package Updates

    • Updated package version from 3.21.0 to 1.0.0-apha.0
    • Added xss library dependency (version 1.0.14)
  • Component Changes

    • Removed some components: UploadList, Upload
    • Removed certain TypeScript definition files like checkbox.ts, dialog-box.ts
  • Potential Impact

    • Slight modifications to component import mechanisms
    • Minor restructuring of module organization

Copy link

coderabbitai bot commented Jan 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request involves a comprehensive refactoring of import statements across multiple mobile component files. The primary change is shifting import paths from @mobile-root/vue-common to @mobile-root/common across numerous Vue and TypeScript files in the mobile components directory. Additionally, some files have been deleted, such as checkbox.ts, dialog-box.ts, file-upload.ts, and upload.vue. The package version has been updated from 3.21.0 to 1.0.0-apha.0, and a new xss dependency has been added.

Changes

File Path Change Summary
packages/mobile/components/*/src/mobile.vue Import paths updated from @mobile-root/vue-common to @mobile-root/common for setup, defineComponent, and other utilities
packages/mobile/components/checkbox/src/checkbox.ts File deleted
packages/mobile/components/dialog-box/src/dialog-box.ts File deleted
packages/mobile/components/file-upload/src/file-upload.ts File deleted
packages/mobile/components/upload/src/mobile.vue Entire component removed
packages/mobile/components/upload-list/src/mobile.vue Entire component removed
packages/mobile/package.json Version updated to 1.0.0-apha.0, xss dependency added

Possibly related PRs

Suggested labels

enhancement, chore

Suggested reviewers

  • kagol

Poem

🐰 Hopping through code with glee,
Import paths shifting, can't you see?
From vue-common to common we leap,
Refactoring's a rabbit's playful sweep!
Components dancing, version takes flight! 🚀


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3502466 and d5ee9fb.

📒 Files selected for processing (70)
  • packages/mobile/components/action-sheet/src/mobile.vue (1 hunks)
  • packages/mobile/components/alert/src/mobile.vue (1 hunks)
  • packages/mobile/components/avatar/src/mobile.vue (1 hunks)
  • packages/mobile/components/badge/src/mobile.vue (1 hunks)
  • packages/mobile/components/button/src/mobile.vue (1 hunks)
  • packages/mobile/components/checkbox-group/src/mobile.vue (1 hunks)
  • packages/mobile/components/checkbox/src/checkbox.ts (0 hunks)
  • packages/mobile/components/checkbox/src/mobile.vue (1 hunks)
  • packages/mobile/components/container/src/mobile.vue (1 hunks)
  • packages/mobile/components/date-picker/src/date-picker.ts (1 hunks)
  • packages/mobile/components/date-picker/src/mobile.vue (1 hunks)
  • packages/mobile/components/dialog-box/src/dialog-box.ts (0 hunks)
  • packages/mobile/components/dialog-box/src/mobile.vue (1 hunks)
  • packages/mobile/components/dropdown-item/src/mobile.vue (1 hunks)
  • packages/mobile/components/dropdown-menu/src/mobile.vue (2 hunks)
  • packages/mobile/components/exception/src/mobile.vue (1 hunks)
  • packages/mobile/components/file-upload/src/file-upload.ts (0 hunks)
  • packages/mobile/components/file-upload/src/mobile.vue (1 hunks)
  • packages/mobile/components/form-item/src/label-wrap.ts (1 hunks)
  • packages/mobile/components/form-item/src/mobile.vue (1 hunks)
  • packages/mobile/components/form/src/mobile.vue (1 hunks)
  • packages/mobile/components/image-viewer/src/mobile.vue (1 hunks)
  • packages/mobile/components/image-viewer/src/mobileTouch.ts (1 hunks)
  • packages/mobile/components/index-bar-anchor/src/index.vue (1 hunks)
  • packages/mobile/components/index-bar/src/mobile.vue (1 hunks)
  • packages/mobile/components/input/src/input.ts (1 hunks)
  • packages/mobile/components/input/src/mobile.vue (1 hunks)
  • packages/mobile/components/label/src/mobile.vue (1 hunks)
  • packages/mobile/components/list/src/mobile.vue (1 hunks)
  • packages/mobile/components/loading/index.ts (1 hunks)
  • packages/mobile/components/loading/src/directive.ts (1 hunks)
  • packages/mobile/components/loading/src/mobile.vue (1 hunks)
  • packages/mobile/components/loading/src/service.ts (1 hunks)
  • packages/mobile/components/mask/src/mobile.vue (1 hunks)
  • packages/mobile/components/message/index.ts (1 hunks)
  • packages/mobile/components/mini-picker/src/mobile.vue (1 hunks)
  • packages/mobile/components/modal/index.ts (1 hunks)
  • packages/mobile/components/modal/src/mobile.vue (1 hunks)
  • packages/mobile/components/multi-select-item/src/mobile.vue (1 hunks)
  • packages/mobile/components/multi-select/src/mobile.vue (1 hunks)
  • packages/mobile/components/multi-select/src/multi-select.ts (1 hunks)
  • packages/mobile/components/nav-bar/src/mobile.vue (1 hunks)
  • packages/mobile/components/numeric/src/mobile.vue (1 hunks)
  • packages/mobile/components/picker-column/src/mobile.vue (1 hunks)
  • packages/mobile/components/popover/src/mobile.vue (1 hunks)
  • packages/mobile/components/popup/src/mobile.vue (1 hunks)
  • packages/mobile/components/progress/src/mobile.vue (1 hunks)
  • packages/mobile/components/pull-refresh/src/mobile.vue (1 hunks)
  • packages/mobile/components/radio-group/src/mobile.vue (1 hunks)
  • packages/mobile/components/radio/src/mobile.vue (1 hunks)
  • packages/mobile/components/search/src/mobile.vue (1 hunks)
  • packages/mobile/components/slider/src/mobile.vue (1 hunks)
  • packages/mobile/components/switch/src/mobile.vue (1 hunks)
  • packages/mobile/components/tab-item/src/mobile.vue (1 hunks)
  • packages/mobile/components/tabbar-item/src/mobile.vue (1 hunks)
  • packages/mobile/components/tabbar/src/mobile.vue (1 hunks)
  • packages/mobile/components/table/src/mobile.vue (1 hunks)
  • packages/mobile/components/tabs/src/mobile.vue (1 hunks)
  • packages/mobile/components/tabs/src/tab-nav/mb.vue (1 hunks)
  • packages/mobile/components/tag/src/mobile.vue (1 hunks)
  • packages/mobile/components/time-line/src/mobile.vue (1 hunks)
  • packages/mobile/components/time-line/src/time-line.ts (1 hunks)
  • packages/mobile/components/toast/src/mobile.vue (1 hunks)
  • packages/mobile/components/toast/src/service.ts (1 hunks)
  • packages/mobile/components/tooltip/src/mobile.vue (1 hunks)
  • packages/mobile/components/upload-list/src/mobile.vue (0 hunks)
  • packages/mobile/components/upload/src/mobile.vue (0 hunks)
  • packages/mobile/components/user-head/src/mobile.vue (1 hunks)
  • packages/mobile/components/wheel/src/mobile.vue (1 hunks)
  • packages/mobile/package.json (2 hunks)

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added the enhancement New feature or request (功能增强) label Jan 10, 2025
Copy link

Walkthrough

This pull request optimizes the common package name used in mobile components by changing imports from @mobile-root/vue-common to @mobile-root/common. This change affects multiple components and aims to standardize the package naming convention across the mobile codebase.

Changes

Files Summary
packages/mobile/common/* No specific changes detailed.
packages/mobile/components/* Updated imports from @mobile-root/vue-common to @mobile-root/common.
packages/mobile/package.json Minor changes in package configuration.

@@ -52,7 +52,7 @@

<script lang="ts">
import { renderless, api } from './renderless/vue'
import { $prefix, setup, defineComponent } from '@mobile-root/vue-common'
import { $prefix, setup, defineComponent } from '@mobile-root/common'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that the new import path @mobile-root/common is correctly configured and available in the project to prevent module resolution errors.

Copy link

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

@zzcr zzcr closed this Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant