Chore: Improve varous aspects of sandbox creation

[tobiasdiez]

What I did

While working on the Nuxt Sandbox, I've encountered a few issues - and these are fixed with this PR.
Namely,

• Copying the temporary sandbox to the storybook folder doesn't work if the code is checked out in a different partition than where the system puts temp files (fs.move only works on the same partition; while fs.copy works also accross partitions)
• On Windows, the Yarn config steps failed due to using touch and due to a strange formatting error (I'm aware that offically WSL is recommended, but that was actualyl the only error I've encountered using Windows directly)
• This error during the yarn setup was never shown, which made debugging this a bit hard.
• The docs mentioned an outdated file where the sandbox should be configured.

All of these points are adressed, each one in their own commit.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	77.6 MB	77.6 MB	0 B	-0.42	0%
initSize	143 MB	146 MB	3.47 MB	0.06	2.4%
diffSize	65.1 MB	68.5 MB	3.47 MB	0.28	5.1%
buildSize	6.82 MB	6.82 MB	-6.64 kB	-0.62	-0.1%
buildSbAddonsSize	1.51 MB	1.5 MB	-6.64 kB	-0.66	-0.4%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	1.85 MB	1.85 MB	0 B	0.42	0%
buildSbPreviewSize	271 kB	271 kB	0 B	0.41	0%
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	3.83 MB	3.82 MB	-6.64 kB	-0.63	-0.2%
buildPreviewSize	3 MB	3 MB	0 B	0.19	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	7.2s	10.2s	2.9s	-0.24	28.9%
generateTime	21.9s	34s	12.1s	7.25	🔺35.7%
initTime	15.8s	20.9s	5s	4.57	🔺24.4%
buildTime	9.9s	8.6s	-1s -305ms	-1.3	🔰-15.1%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	6.6s	7.3s	684ms	0.2	9.3%
devManagerResponsive	4s	4.6s	605ms	-0.13	13%
devManagerHeaderVisible	621ms	639ms	18ms	0.05	2.8%
devManagerIndexVisible	710ms	713ms	3ms	0.12	0.4%
devStoryVisibleUncached	1s	741ms	-304ms	-1.19	-41%
devStoryVisible	709ms	672ms	-37ms	-0.05	-5.5%
devAutodocsVisible	521ms	606ms	85ms	0.17	14%
devMDXVisible	543ms	589ms	46ms	0.02	7.8%
buildManagerHeaderVisible	558ms	603ms	45ms	-0.21	7.5%
buildManagerIndexVisible	576ms	610ms	34ms	-0.36	5.6%
buildStoryVisible	557ms	601ms	44ms	-0.29	7.3%
buildAutodocsVisible	484ms	509ms	25ms	-0.32	4.9%
buildMDXVisible	463ms	510ms	47ms	-0.12	9.2%

Greptile Summary

This PR improves various aspects of sandbox creation in Storybook, addressing cross-platform compatibility issues and enhancing error handling.

• Updated docs/contribute/code.mdx with correct file path for sandbox templates
• Modified scripts/sandbox/generate.ts to use copy instead of rename for cross-partition compatibility
• Improved scripts/sandbox/utils/yarn.ts for Windows compatibility by replacing touch with fs.writeFileSync()
• Updated Yarn configuration in scripts/utils/yarn.ts to use string format for unsafeHttpWhitelist

[greptile-apps]

_{4 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings}

[greptile-apps]

style: Ensure this operation is wrapped in a try-catch block to handle potential file system errors

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ee5a4f6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx run-many -t build --parallel=3

---

Sent with 💌 from NxCloud.