[docs-infra] Improve export into sandbox package.json #46044
Conversation
oliviertassinari
added
enhancement
Netlify deploy previewhttps://deploy-preview-46044--material-ui.netlify.app/ Bundle size report |
| private: true, | ||
| description, |
There was a problem hiding this comment.
Because people might eject out of StackBlitz, the description we add to the StackBlitz, seems also relevant in the package.json.
| @@ -64,8 +65,9 @@ export default defineConfig({ | |||
| 'index.html': CRA.getHtml({ ...demoData, main: `/src/index.${ext}` }), | |||
| 'package.json': JSON.stringify( | |||
| { | |||
| name: 'mui-demo', | |||
| version: process.env.LIB_VERSION, | |||
There was a problem hiding this comment.
Because we set "latest" for the dependencies version, and most people who create reproduction never pin the npm packages version, having the versions set at the root should help us reproduce 2+ years old bugs when we try to iterate on some logic.
There was a problem hiding this comment.
That's not very useful to recreate the installed environment. First, our packages follow independent versioning so it can't be captured in a single version number. And second, it won't capture transitive dependencies. i.e. you may fix the @mui/material version to 7.3.6, its @mui/utils dependency is defined with caret range, so it may as well install 7.56.12 of that package. Or the bug may have been in vite.
There will be a lockfile in the sandbox of the reproduction which should be sufficient to recreate and inspect the conditions of the bug.
There was a problem hiding this comment.
That's not very useful to recreate the installed environment
@Janpot Oh yeah, agree, it only helps to know it's v4 and not v5 or v6 😆.
There will be a lockfile in the sandbox of the reproduction which should be sufficient to recreate and inspect the conditions of the bug.
In the reproduction provided in https://github.com/mui/material-ui/issues, none seems to have this.
(A side note, they all seem to prefer CodeSandbox even when we push to StackBlitz by default in the instructions, maybe some SEO lag, or something else.)
There was a problem hiding this comment.
it only helps to know it's v4 and not v5 or v6
Wouldn't it make more sense then to just replace "latest" with ""?
There was a problem hiding this comment.
Yeah, I think it would be better, but this is more time-consuming to implement. I think we can narrow the scope down, make the PR simpler. I'm reverting the version.
| @@ -56,7 +56,6 @@ describe('StackBlitz', () => { | |||
| </body> | |||
| </html>`, | |||
| 'package.json': `{ | |||
| "name": "mui-demo", | |||
| ...(templateData.codeVariant === 'TS' && { | ||
| main: 'index.tsx', | ||
| }), |
| version: process.env.LIB_VERSION, | ||
| private: true, |
There was a problem hiding this comment.
Having it private sounds wise. Avoid spam on npm.
| @@ -262,6 +260,8 @@ ReactDOM.createRoot(document.querySelector("#root")${type}).render( | |||
|
|
|||
| files['package.json'] = { | |||
| content: { | |||
| version: process.env.LIB_VERSION, | |||
There was a problem hiding this comment.
Same as for StackBlitz
oliviertassinari
force-pushed
the
set-version-in-code-export
branch
from
7454943 to
c6cbb07
Compare
From #46034, I noticed that we could sync the CodeSandbox and StackBlitz experience, pick the best of the two worlds.
A continuation of #45924.
Preview: https://deploy-preview-46044--material-ui.netlify.app/material-ui/react-alert/#introduction