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: add vite-plugin-vue-inspector #4063

Closed
wants to merge 2 commits into from

Conversation

warmthsea
Copy link
Contributor

@warmthsea warmthsea commented Aug 7, 2024

  • 新增 vite-plugin-vue-inspector 选中DOM 快速打开 IDE代码行数
  • 更改 @core 文件夹名为 core (windows 限制不能打开别名带有 @ 的路径)

相关 PR #3725

screenshots

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Introduced the vite-plugin-vue-inspector to enhance Vue component debugging capabilities across multiple applications.
  • Bug Fixes

    • Updated directory paths in configuration files for improved consistency and clarity in package structure.
  • Documentation

    • Minor updates to project documentation reflecting adjusted paths for core packages.
  • Chores

    • Added new development dependencies to various projects to support enhanced tooling for Vue development.

@warmthsea warmthsea requested review from anncwb, vince292007 and a team as code owners August 7, 2024 02:32
Copy link

changeset-bot bot commented Aug 7, 2024

⚠️ No Changeset found

Latest commit: 659cb8c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 7, 2024

Walkthrough

The recent changes focus on enhancing the development environment across multiple projects by updating configurations and dependencies. Notably, the vite-plugin-vue-inspector has been added to several applications to improve Vue component debugging. Additionally, directory paths in configuration files have been simplified by removing scoped naming, promoting clarity and consistency across the codebase.

Changes

Files Change Summary
.ls-lint.yml, apps/web-antd/package.json, apps/web-antd/vite.config.mts, apps/web-ele/package.json, apps/web-ele/vite.config.mts, apps/web-naive/package.json, apps/web-naive/vite.config.mts Added vite-plugin-vue-inspector to devDependencies and Vite configurations for improved Vue debugging.
docs/src/guide/other/project-update.md Updated path reference from packages/@core to packages/core.
internal/lint-configs/eslint-config/src/custom-config.ts Standardized file paths and messages by removing '@' symbol.
packages/core/composables/package.json, packages/core/preferences/package.json Updated repository.directory paths from @core to core.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Vite
    participant VueInspector

    Developer->>Vite: Start development server
    Vite->>VueInspector: Initialize Inspector plugin
    VueInspector-->>Vite: Ready for component inspection
    Developer->>Vite: Inspect Vue component
    Vite->>VueInspector: Request component details
    VueInspector-->>Vite: Return component information
    Vite-->>Developer: Display inspection results
Loading

Poem

🐇 In the meadow, changes bloom,
Paths now clear, dispel the gloom.
With Inspector, we take flight,
Debugging Vue, what a delight!
Hop and skip, let joy unfold,
In our code, new tales are told. 🌼


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>.
    • 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.

@likui628 likui628 changed the title refactor: change @core folder to core & add Inspector (developer open vscode) feat: add vite-plugin-vue-inspector Aug 7, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 891fd80 and 659cb8c.

Files selected for processing (11)
  • .ls-lint.yml (1 hunks)
  • apps/web-antd/package.json (1 hunks)
  • apps/web-antd/vite.config.mts (1 hunks)
  • apps/web-ele/package.json (1 hunks)
  • apps/web-ele/vite.config.mts (1 hunks)
  • apps/web-naive/package.json (1 hunks)
  • apps/web-naive/vite.config.mts (1 hunks)
  • docs/src/guide/other/project-update.md (1 hunks)
  • internal/lint-configs/eslint-config/src/custom-config.ts (5 hunks)
  • packages/core/composables/package.json (1 hunks)
  • packages/core/preferences/package.json (1 hunks)
Files skipped from review due to trivial changes (6)
  • .ls-lint.yml
  • apps/web-naive/package.json
  • docs/src/guide/other/project-update.md
  • internal/lint-configs/eslint-config/src/custom-config.ts
  • packages/core/composables/package.json
  • packages/core/preferences/package.json
Additional comments not posted (5)
apps/web-antd/vite.config.mts (1)

9-9: LGTM! Verify the plugin functionality.

The vite-plugin-vue-inspector is correctly integrated into the Vite configuration. Ensure to verify its functionality during development to confirm it enhances the debugging experience as expected.

apps/web-naive/vite.config.mts (1)

9-9: LGTM! Verify the plugin functionality.

The vite-plugin-vue-inspector is correctly integrated into the Vite configuration. Ensure to verify its functionality during development to confirm it enhances the debugging experience as expected.

apps/web-ele/vite.config.mts (1)

11-11: LGTM! Verify the plugin functionality.

The vite-plugin-vue-inspector is correctly integrated into the Vite configuration. Ensure to verify its functionality during development to confirm it enhances the debugging experience as expected.

apps/web-antd/package.json (1)

50-51: Approved: Addition of vite-plugin-vue-inspector

The addition of vite-plugin-vue-inspector to devDependencies enhances the development experience by allowing developers to quickly open the corresponding line of code in their IDE by selecting a DOM element. The version constraint ^4.0.2 seems appropriate.

apps/web-ele/package.json (1)

51-52: Approved: Addition of vite-plugin-vue-inspector

The addition of vite-plugin-vue-inspector to devDependencies enhances the development experience by allowing developers to quickly open the corresponding line of code in their IDE by selecting a DOM element. The version constraint ^4.0.2 seems appropriate.

apps/web-antd/vite.config.mts Show resolved Hide resolved
apps/web-naive/vite.config.mts Show resolved Hide resolved
apps/web-ele/vite.config.mts Show resolved Hide resolved
@likui628
Copy link
Collaborator

likui628 commented Aug 7, 2024

@warmthsea 配置有vue devtools了,这个感觉必要性不大了

@warmthsea
Copy link
Contributor Author

@warmthsea 配置有vue devtools了,这个感觉必要性不大了

抱歉我没有看到有内置的,那这个 pr 没有必要了

@warmthsea warmthsea closed this Aug 7, 2024
@warmthsea warmthsea deleted the refactor/core-folder branch August 7, 2024 03:07
@github-actions github-actions bot locked and limited conversation to collaborators Sep 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants