feat: detect bun in create-tauri-app (#481)

* feat: detect bun in create-tauri-app

* Add changeset

* add bun in CI

* Update .scripts/generate-templates-matrix.js

* replace bunx with bun x

* fmt

* fix bun cmds

* fmt

* fix bun vanilla

---------

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>

Author: colinhacks

.changes/bun-pm.md

@@ -0,0 +1,6 @@
+---
+"create-tauri-app": minor
+"create-tauri-app-js": minor
+---
+
+Support and detect Bun package manager

.github/CONTRIBUTING.md

@@ -83,7 +83,7 @@ A template is a just combination of two fragments, [`_base_`](../packages/cli/fr
   tauri.svg = public/tauri.svg
   ```
 - In `<repo-root>/packages/cli/src/template.rs`, add an entry in the `Template` enum, modify `post_init_info`, `flavors` and `from_flavor` if needed and modify `FromStr` and `Display` implementation
-- In `<repo-root>/packages/cli/src/package_manager.rs` add your new template to the appropraite package manager in the `templates` method
+- In `<repo-root>/packages/cli/src/package_manager.rs` add your new template to the appropriate package manager in the `templates` method
 - Modify `<repo-root>/.scripts/generate-templates-matrix.js` and append the template name inside the template list for the appropriate package manager so the CI would run tests for it.
 - If the template requires system dependencies, add a post init note in `<repo-root>/packages/cli/src/template.rs` in `post_init_info` method.
 - Before making a commit, make sure to run `cargo fmt --all` and `pnpm format` in the repo root.

.github/workflows/templates-test.yml

@@ -73,6 +73,11 @@ jobs:
         with:
           version: 8
 
+      - uses: oven-sh/setup-bun@v1
+        if: matrix.settings.manager == 'bun'
+        with:
+          bun-version: latest
+
       - name: Install Node.js@16
         if: matrix.settings.manager != 'cargo'
         uses: actions/setup-node@v2

.scripts/generate-templates-matrix.js

@@ -41,6 +41,12 @@ const matrixConfig = [
     run_cmd: "cargo",
     templates: ["vanilla", "yew", "leptos"],
   },
+  {
+    manager: "bun",
+    install_cmd: "bun install",
+    run_cmd: "bun run",
+    templates: nodeJsTemplates,
+  },
 ];
 
 const outMatrix = [];

README.md

@@ -54,6 +54,12 @@ yarn create tauri-app
 pnpm create tauri-app
 ```
 
+## Bun:
+
+```bash
+bunx create-tauri-app
+```
+
 <br>
 
 You can also directly specify the project name, package manager and the template you want to use via additional command line options. For example, to scaffold a Svelte project in a `my-tauri-app` directory, run:
@@ -75,6 +81,8 @@ npm create tauri-app@latest my-tauri-app -- --template svelte --manager pnpm
 yarn create tauri-app my-tauri-app --template svelte --manager pnpm
 # pnpm
 pnpm create tauri-app my-tauri-app --template svelte --manager pnpm
+# Bun
+bunx create-tauri-app my-tauri-app --template svelte --manager bun
 ```
 
 Currently supported template presets include:

…pnpm-yarn-npm-alpha-mobile)%package.json …-yarn-npm-bun-alpha-mobile)%package.jsonpackages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-alpha-mobile)%package.json renamed to packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-bun-alpha-mobile)%package.json packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-alpha-mobile)%package.json renamed to packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-bun-alpha-mobile)%package.json

@@ -29,6 +29,12 @@ yarn create tauri-app
 pnpm create tauri-app
 ```
 
+## Bun:
+
+```bash
+bunx create-tauri-app
+```
+
 <br>
 
 You can also directly specify the project name, package manager and the template you want to use via additional command line options. For example, to scaffold a Svelte project in a `my-tauri-app` directory, run:
@@ -42,6 +48,8 @@ npm create tauri-app@latest my-tauri-app -- --template svelte --manager pnpm
 yarn create tauri-app my-tauri-app --template svelte --manager pnpm
 # pnpm
 pnpm create tauri-app my-tauri-app --template svelte --manager pnpm
+# Bun
+bunx create-tauri-app my-tauri-app --template svelte --manager bun
 ```
 
 Currently supported template presets include:

…lla/%(pnpm-yarn-npm-stable)%package.json …%(pnpm-yarn-npm-bun-stable)%package.jsonpackages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-stable)%package.json renamed to packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-bun-stable)%package.json packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-stable)%package.json renamed to packages/cli/fragments/fragment-vanilla/%(pnpm-yarn-npm-bun-stable)%package.json

@@ -16,9 +16,9 @@ let binName;
 if (bin === "@tauri-apps/cli") {
   binName = "@tauri-apps/cli";
 }
-// Even if started by a package manager, the binary will be NodeJS.
+// Even if started by a package manager, the binary will be NodeJS or Bun.
 // Some distribution still use "nodejs" as the binary name.
-if (binStem.match(/(nodejs|node)-*([1-9]*)*$/g)) {
+if (binStem.match(/(nodejs|node|bun)-*([1-9]*)*$/g)) {
   const managerStem = process.env.npm_execpath
     ? path.parse(process.env.npm_execpath).name.toLowerCase()
     : null;
@@ -30,7 +30,7 @@ if (binStem.match(/(nodejs|node)-*([1-9]*)*$/g)) {
         manager = "npm";
         break;
 
-      // Yarn and pnpm have the same stem name as their bin.
+      // Yarn, pnpm, and Bun have the same stem name as their bin.
       // We assume all unknown package managers do as well.
       default:
         manager = managerStem;

packages/cli/node/README.md

@@ -24,6 +24,7 @@ impl<'a> Category {
                 PackageManager::Pnpm,
                 PackageManager::Yarn,
                 PackageManager::Npm,
+                PackageManager::Bun,
             ],
         }
     }