Configure website Yarn node_modules linker#847
Conversation
|
@maxliebscher is attempting to deploy a commit to the scroll Team on Vercel. A member of the Team first needs to authorize it. |
|
Quick note on the Vercel check: this PR only changes the website Yarn configuration. I validated it locally in WSL2 with |
c6d23ae to
62f1fca
Compare
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 62f1fca317
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1 @@ | |||
| nodeLinker: node-modules | |||
There was a problem hiding this comment.
Ignore Yarn node-modules state artifacts
With this linker, the documented yarn/yarn install workflow now writes Yarn state under .yarn/ (for example .yarn/install-state.gz and unplugged packages), but scrollprize.org/.gitignore only ignores node_modules and build outputs. In a clean checkout this leaves generated dependency artifacts untracked, and a routine git add . can accidentally stage thousands of files; add the corresponding .yarn/ ignores alongside this config change.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in cef84924 by adding Yarn generated-state ignores under scrollprize.org/.gitignore: .yarn/* with the standard Yarn project directories left unignored, plus .pnp.*.
@maxliebscher was that happening for you? "The Docusaurus build fails" seems like a strong claim, is that something that started failing recently (since we are actively deploying the site regularly)? |
|
@jrudolph yes, this was from my local clean-install check on 2026-04-29 in WSL2 Ubuntu 24.04. I agree the original wording was too broad, so I updated the PR description to scope it to that local setup. What I saw was: without I also reran the validation on the current PR head after the follow-up Result: |
Summary
Configure the ScrollPrize website workspace to use Yarn's
node-moduleslinker and ignore the Yarn state files generated by that install mode.Why
The repo pins Yarn 4.6.0 via
packageManager, but in a clean local WSL2 install without a.yarnrc.yml, Yarn 4 used Plug'n'Play. In that local setup, the Docusaurus production build failed while resolving several peer/transitive imports used by the current dependency tree, including@docusaurus/plugin-content-docs,katex/dist/katex.min.css, andvscode-languageserver-types.With
nodeLinker: node-modules, the same lockfile installs and the Docusaurus production build completes. The PR also ignores generated Yarn state such as.yarn/install-state.gz, unplugged packages, and.pnp.*, while preserving the usual Yarn project directories if they are added later.Validation
Ran in WSL2 Ubuntu 24.04 from
scrollprize.org:Result:
Notes:
@types/reactpeer warning.