Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Migrates the project package manager from npm to Bun to significantly reduce dependabot PR noise. Bun's
bun.lockblock file is ~90% smaller than npm'spackage-lock.json, which translates to far fewer lock file update notifications from dependabot. This change maintains full compatibility with existing npm scripts and the same dependency ecosystem while improving performance and reducing GitHub notification spam.Type of Change
Changes Made
package.jsonto usebun runinprepublishOnlyscript and added"packageManager": "bun@latest"fieldbunfig.tomlwith bun runtime configuration for test, install, and build settings.github/dependabot.ymlto trackbunpackage ecosystem instead ofnpm.github/workflows/publish.ymlto useoven-sh/setup-bun@v1and replaced allnpm ci/npm run/npm publishcommands with bun equivalents in both test and publish jobsSETUP.mdto reflect bun as the package manager with updated installation and script instructionsREADME.mdto add bun installation instructions (bun add react-api-forge).gitignoreto excludebun.lockband.bun/directory while removing duplicate npm cache entriesTesting
Checklist
Related Issues
N/A
Screenshots (if applicable)
Not applicable
Additional Notes
Benefits of this migration:
bun runbun.lockbis binary and significantly more compact than text-basedpackage-lock.jsonMigration path for users:
node_modules/andpackage-lock.jsonbun installto generatebun.lockbbun run <script>for all build/test/lint commandsDeployment Notes
Lock file replacement: The
bun.lockbfile replacespackage-lock.jsonin version control. GitHub Actions workflows automatically use bun for all dependency installation and build steps. No additional infrastructure changes required.Backward compatibility: npm and yarn users can still install the package via
npm install react-api-forgeoryarn add react-api-forge—the package remains published to npm registry without changes.For Template Users:
If you're using this template, please update this section with your specific PR template requirements.
For Maintainers: