Skip to content

Instantly share code, notes, and snippets.

@R-ohit-B-isht

R-ohit-B-isht/migrating to bun.playbook.md

Created April 22, 2024 04:20
Show Gist options
  • Save R-ohit-B-isht/957ef06ea5e99c90dc594029a1bd57d1 to your computer and use it in GitHub Desktop.
Save R-ohit-B-isht/957ef06ea5e99c90dc594029a1bd57d1 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
migrating to bun.playbook.md

Playbook: Migrating a Project to Bun

Overview

This playbook provides guidance on migrating an existing project to the Bun JavaScript runtime and bundler. It covers assessing compatibility, configuring Bun, updating build scripts, and verifying functionality.

Prerequisites

Procedure

1. Assess Project Compatibility

1a. Review Documentation: Familiarize yourself with Bun's capabilities, limitations, and compatibility by reading the documentation.

1b. Check Compatibility: Verify compatibility of the project's dependencies and frameworks with Bun using the official compatibility list or seeking community support.

1c. Identify Changes: Identify and address any potential compatibility issues or required code changes for a seamless migration.

2. Install Bun and Dependencies

2a. Install Dependencies: Use bun install command to install project dependencies.

3. Update

3a. Consult Documentation: Refer to Bun documentation for guidance on configuring additional plugins or customizations on migrating to Bun instead of your previous build tool, Package Manager, Bundler, Test Runner, Runtime Environment with the current framework .

3b. Modify package.json: Update or create new scripts in package.json to use Bun for testing, building, documentation, etc.

3c. Conditional Migration:

  • i. Build Tool Migration:

    • Determine if the project uses a different build tool. If yes, migrate the build tool to Bun.

  • ii. Package Manager Migration:

    • Assess if there's a need to migrate the package manager. If so, migrate the package manager to Bun.

  • iii. Bundler Migration:

    • Check if the project uses a different bundler. If needed, migrate the bundler to Bun.

  • iv. Test Runner Migration:

    • Determine if the project's test runner needs migration. If required, migrate the test runner to Bun.

  • v. Runtime Environment Migration:

    • Evaluate if there's a need to migrate the runtime environment. If necessary, migrate the runtime environment to Bun.

  • vi. Migrating from types/node TS to bun-type :

    • i. Remove "@types/node"

      • Before installing "bun-types", any existing Node.js type definitions should be removed to prevent conflicts.

    • ii. Install "bun-types"

      • Install the Bun TypeScript definitions which are optimized for Bun's JavaScript runtime.

    • iii. Update tsconfig.json

      • Modify the tsconfig.json file to include "bun-types" in the types array. This ensures that TypeScript is aware of Bun-specific type definitions.

4. Perform Migration

4a. Run Scripts: Execute updated scripts using Bun.

4b. Address Issues: Address any errors or warnings encountered during migration.

4c. Make Adjustments: Modify code or configurations if necessary to resolve compatibility issues.

5. Verify Functionality

5a. Thorough Testing: Test the migrated project extensively using Bun.

5b. Ensure Stability: Confirm that the project functions as expected without regressions or breaking changes.

6. Deploy and Share

6a. Public Deployment: Make the migrated project accessible via a public temporary ngrock URL to showcase its functionality (Verify the URL is accessible).

6b. Share URL: Share the URL with the user to demonstrate the migrated project.

Additional Steps (Optional)

  • Push/Pull to GitHub: Only push or pull from GitHub repositories when specified by the user.

Advice and Pointers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment