fix(docs): failed to install dependencies in StackBlitz

[wingkwong]

Closes #4617

📝 Description

This PR is to

• exclude react-dom/client from package.json
• exclude dependencies which are already defined in devDependencies
• align the versions across StackBlitz

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

• Dependency Updates
  • Updated versions of autoprefixer, postcss, and tailwindcss in development dependencies
  • Modified dependency exclusion list in Stackblitz configuration to include additional packages

These updates reflect package version improvements and refined dependency management in the project.

[linear]

ENG-1926 [BUG] - StackBlitz failures

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0140866

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 4:45pm
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 4:45pm

[coderabbitai]

Walkthrough

The pull request involves updates to dependency versions in two files: use-sandpack.ts and use-stackblitz.ts. The changes primarily focus on updating package versions for autoprefixer, postcss, and tailwindcss, and modifying the list of dependencies excluded in the useStackblitz function to address potential StackBlitz initialization issues.

Changes

File	Change Summary
apps/docs/components/sandpack/use-sandpack.ts	Updated dependency versions: - autoprefixer: ^10.4.14 → 10.4.20 - postcss: ^8.4.21 → 8.4.49 - tailwindcss: ^3.2.7 → 3.4.17
apps/docs/hooks/use-stackblitz.ts	Expanded list of omitted dependencies in packageJson, now including: - react-dom/client - @vitejs/plugin-react - vite - autoprefixer - postcss - tailwindcss

Assessment against linked issues

Objective	Addressed	Explanation
Resolve StackBlitz initialization error	✅
Fix package name issues with react-dom/client	✅

The changes directly address the StackBlitz failures reported in issue #4617 by modifying the dependencies handling in the useStackblitz hook.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ceb6385 and 0140866.

📒 Files selected for processing (2)

• apps/docs/components/sandpack/use-sandpack.ts (1 hunks)
• apps/docs/hooks/use-stackblitz.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• apps/docs/components/sandpack/use-sandpack.ts

🔇 Additional comments (1)

apps/docs/hooks/use-stackblitz.ts (1)

55-66: Ensure these omissions don't break references during runtime.

By excluding these dependencies (react-dom/client, @vitejs/plugin-react, vite, autoprefixer, postcss, and tailwindcss) from the final dependencies object, you align with the goal of removing dev-only packages from production. This is consistent with the PR objectives. However, verify that none of these dependencies are required at runtime. If any references to them remain in the built code, it could cause breakages.

As a follow-up, you may consider programmatically excluding all dev-only dependencies by referencing your devDependencies object, rather than maintaining this hardcoded list.

✨ 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

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

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.

[ryo-manba]

The failure might be due to the absence of a package-lock.json.
Wouldn't providing the package-lock.json be enough to resolve the issue?

[wingkwong]

@ryo-manba you may compare those 2 stackblitz projects from code tab and previous tab. The one from Preview tab works fine even without lock file. Don't know why there are two different implementations tho, may need to check with winches. This PR is more like hot fix so that users can see the stackblitz project from Code tab.

[ryo-manba]

The one from Preview tab works fine even without lock file.

Oh, I misunderstood. The package-lock.json was simply generated as a result of running npm install.

[ryo-manba]

LGTM, let's apply this as a temporary fix for now.
Eventually, it would be better to unify it.