feat(ui): add StackBlitzPreview and migrate examples directory from webpack.js.org - #248
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No dependency changes detected. Learn more about Socket for GitHub. 👍 No dependency changes detected in pull request |
e160d41 to
76b5a11
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. WalkthroughAdded the Merge Risk: 🟡 Moderate · up to The new documentation previews currently target the wrong example repository, and the getting-started example still cannot render through its documented serve flow because it lacks an HTML entry. These issues can make the newly linked examples unusable, so they should be fixed or explicitly accepted before merging. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
examples/module-federation/app1/src/App.js (1)
17-19: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winHandle rejected remote loads with an Error Boundary.
The current fallback covers only the pending load. If
remoteEntry.jsor the exposed module fails,React.lazysends the rejection to the nearest Error Boundary instead of thisSuspensefallback. (react.dev)If the application root does not already provide an Error Boundary, add one around
RemoteAppso the preview shows a recoverable error.eslint.config.mjs (1)
32-32: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep runnable examples covered by validation.
The
examples/directory now bypasses the repository's ESLint checks. If the ignore is required for imported example style, add a separate CI smoke check that installs and builds each preview example. Otherwise, narrow the ignore pattern. This prevents the documentation from advertising an example that cannot compile.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4d49e55d-1f1b-41da-bd83-221202eb10ab
⛔ Files ignored due to path filters (2)
examples/getting-started/dist/index.htmlis excluded by!**/dist/**public/assets/open-in-stackblitz-button.svgis excluded by!**/*.svg
📒 Files selected for processing (25)
components/StackBlitzPreview/index.jsxcomponents/StackBlitzPreview/index.module.csseslint.config.mjsexamples/getting-started/README.mdexamples/getting-started/package.jsonexamples/getting-started/src/index.jsexamples/getting-started/webpack.config.jsexamples/module-federation/README.mdexamples/module-federation/app1/package.jsonexamples/module-federation/app1/public/index.htmlexamples/module-federation/app1/src/App.jsexamples/module-federation/app1/src/bootstrap.jsexamples/module-federation/app1/src/index.jsexamples/module-federation/app1/webpack.config.jsexamples/module-federation/app2/package.jsonexamples/module-federation/app2/public/index.htmlexamples/module-federation/app2/src/App.jsexamples/module-federation/app2/src/bootstrap.jsexamples/module-federation/app2/src/index.jsexamples/module-federation/app2/webpack.config.jsexamples/module-federation/lerna.jsonexamples/module-federation/package.jsonpages/guides/getting-started/concepts/module-federation.mdpages/guides/getting-started/index.mdscripts/html/doc-kit.config.mjs
Included review availability: Your plan includes up to 3 reviews per rolling hour; 2 remain after this review.
Trying to understand why Socket believes we use |
|
@ovflowd socket probably thinks that all the dependencies from the examples are added, but they aren't |
That adds quite the noise :/ |
Yeah, I just investgated it and found that in |
Before pushing this PR, I actually thought about why we should add examples dir in our repo. The So, WDUT?! |
|
I'm not sure if we need examples in this repo, or at all, nothing reads then, right? |
Just the const url = `https://stackblitz.com/github/webpack/webpack-doc-kit/tree/main/examples/${example}`;to |
|
Oh! Right, ha! I forgot that these aren't hosted on StackBlitz itself |
Summary
This PR replaces TODOs that related to
StackBlitzPreviewafter adding it as component with the same design from webpack.js.org with our colors and migrates the examples directory from webpack.js.orgSummary by CodeRabbit
New Features
Documentation