Skip to content

fix(setup): bun run prepare explicitly#3947

Merged
icecrasher321 merged 1 commit intosimstudioai:stagingfrom
abhinavDhulipala:pre-commit
Apr 4, 2026
Merged

fix(setup): bun run prepare explicitly#3947
icecrasher321 merged 1 commit intosimstudioai:stagingfrom
abhinavDhulipala:pre-commit

Conversation

@abhinavDhulipala
Copy link
Copy Markdown
Contributor

@abhinavDhulipala abhinavDhulipala commented Apr 4, 2026

Summary

Bun v1.3.11 does not run the root workspace package's prepare lifecycle script during bun install.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • Other: ___________

Testing

Found out the hook didn't run by doing the following:

  1. Set "prepare": "echo PREPARE_SCRIPT_RUNNING"
  2. Ran rm -rf node_modules && bun install | grep PREPARE_SCRIPT_RUNNING
  3. The echo never appeared in output
  4. bun run prepare worked fine when invoked explicitly

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 4, 2026

PR Summary

Low Risk
Low risk: documentation-only change that just makes the manual setup steps more reliable by ensuring Husky/pre-commit hooks are installed.

Overview
Updates the manual self-hosted setup instructions in README.md to explicitly run bun run prepare after bun install, ensuring pre-commit hooks (via the repo prepare script) are set up even when Bun doesn’t auto-run the lifecycle script.

Reviewed by Cursor Bugbot for commit 72225f0. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 4, 2026

@abhinavDhulipala is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 4, 2026

Greptile Summary

This PR adds a single line to the README installation steps — bun run prepare — to compensate for a Bun v1.3.11 regression where the root workspace package's prepare lifecycle script is silently skipped during bun install. The fix is minimal, accurate, and well-tested by the author.

  • Adds bun run prepare # Set up pre-commit hooks immediately after bun install in the quick-start code block
  • Ensures pre-commit hooks (e.g. Husky) are properly initialised for new contributors cloning the repo
  • No code logic is changed; this is a documentation-only fix

Confidence Score: 5/5

Safe to merge — documentation-only change that correctly addresses a Bun v1.3.11 lifecycle script regression

Single-line README addition with no code logic changes; the author verified the Bun regression through manual testing and the fix (explicitly calling bun run prepare) is the correct workaround

No files require special attention

Important Files Changed

Filename Overview
README.md Adds bun run prepare step to the installation instructions to explicitly run the prepare lifecycle script, which Bun v1.3.11 skips during bun install

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[git clone] --> B[bun install]
    B -->|Before fix| C{Bun v1.3.11 skips\nprepare script}
    B -->|After fix| D[bun run prepare]
    C --> E[Pre-commit hooks NOT set up\n⚠️ Git hooks missing]
    D --> F[Pre-commit hooks set up\n✅ Git hooks ready]
Loading

Reviews (1): Last reviewed commit: "fix(setup): bun run prepare explicitly" | Re-trigger Greptile

@icecrasher321 icecrasher321 changed the base branch from main to staging April 4, 2026 23:13
@icecrasher321 icecrasher321 merged commit f39b4c7 into simstudioai:staging Apr 4, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants