Skip to content

docs: added configuration examples to improve all TinyVue related dependencies to solve the problem that pnpm projects need to install multiple sub-packages #3377

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Apr 30, 2025

在 import-components.md 中添加提升所有 TinyVue 相关依赖的配置示例,解决pnpm工程需要安装多个子包的问题

PR

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

  • Documentation
    • Added a configuration tip for pnpm users to improve dependency hoisting of TinyVue packages by updating the .npmrc file.

Copy link

coderabbitai bot commented Apr 30, 2025

Walkthrough

A new configuration recommendation was added for pnpm-based projects in the documentation. The update suggests including a public-hoist-pattern[]=@opentiny/* entry in the root .npmrc file to ensure all TinyVue-related packages are properly hoisted. This complements the existing guidance on explicitly declaring TinyVue component dependencies in the package.json, offering an alternative approach for dependency management.

Changes

File(s) Change Summary
examples/sites/demos/pc/webdoc/import-components.md Added documentation about using public-hoist-pattern[]=@opentiny/* in .npmrc for pnpm projects

Poem

A hop and a skip, a tip for your pack,
Add hoist to your pnpm, no need to look back!
With @opentiny/* floating up high,
Your TinyVue imports will surely comply.
So tweak your configs, let dependencies sing—
A rabbit’s delight in the joy that it brings! 🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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 documentation 对文档的改进或补充 label Apr 30, 2025
Copy link

Walkthrough

import-components.md 中添加了一个配置示例,通过在项目根目录的 .npmrc 文件中提升所有 TinyVue 相关依赖,解决了 pnpm 工程需要安装多个子包的问题。

Changes

文件 概要
examples/sites/demos/pc/webdoc/import-components.md 添加了一个配置示例,指导如何在 .npmrc 文件中提升所有 TinyVue 相关依赖。

@@ -73,6 +73,13 @@ module.exports = {
}
```

或者,你也可以在项目根目录的 `.npmrc` 文件中添加以下配置来提升所有 TinyVue 相关的依赖:

Choose a reason for hiding this comment

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

This addition provides a configuration example to enhance all TinyVue-related dependencies by modifying the .npmrc file. It addresses the issue where pnpm projects require multiple sub-packages to be installed. Ensure that this configuration is compatible with existing project setups.

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Walkthrough

Added a configuration example in import-components.md to solve the problem that the pnpm project needs to install multiple subpackages by elevating all TinyVue-related dependencies in the .npmrc file in the root directory of the project.

Changes

Documents Summary
examples/sites/demos/pc/webdoc/import-components.md Added a configuration example to guide you how to improve all TinyVue-related dependencies in the .npmrc file.

Copy link

@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: 0

🧹 Nitpick comments (3)
examples/sites/demos/pc/webdoc/import-components.md (3)

76-82: Consider linking to pnpm's official documentation
To help users understand and experiment with public-hoist-pattern, add a link to the pnpm docs (e.g., https://pnpm.io/npmrc#public-hoist-pattern). This gives more context on how this setting works and what other options are available.


76-82: Clarify supported pnpm versions
It may be helpful to mention that the public-hoist-pattern setting requires pnpm v7+ (or whichever minimum version your project supports) to avoid confusion for users on older pnpm releases.


78-81: Use npmrc code fence for better syntax highlighting
Switch the snippet’s fence from ini to npmrc so editors and docs generators apply proper syntax highlighting for a .npmrc file.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7ca72cd and 775b257.

📒 Files selected for processing (1)
  • examples/sites/demos/pc/webdoc/import-components.md (1 hunks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 对文档的改进或补充
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants