feat: auto-detect package manager (#486)

* feat: auto-detect package manager

* fmt

Author: amrbashir

.changes/detect-package-manager.md

@@ -0,0 +1,7 @@
+---
+"create-tauri-app": "minor"
+"create-tauri-app-js": "minor"
+---
+
+Auto-detect package manager used to run `create-tauri-app` and promote the most relevant category for it and select it and also make the package manager selected by default in the managers selection list.
+

.github/workflows/fmt.yml

@@ -25,7 +25,7 @@ jobs:
 
       - run: cargo fmt --all -- --check
 
-  prttier-fmt-check:
+  prettier-fmt-check:
     runs-on: ubuntu-latest
 
     steps:

packages/cli/node/create-tauri-app.js

@@ -49,4 +49,10 @@ if (binStem.match(/(nodejs|node|bun)-*([1-9]*)*$/g)) {
   args.unshift(bin);
 }
 
-cli.run(args, binName);
+// adapted from https://github.com/vitejs/vite/blob/34826aae015ed16dc9b9096c0f778154ca6981a6/packages/create-vite/src/index.ts#L513
+function pkgManagerFromUserAgent(userAgent) {
+  if (!userAgent) return undefined;
+  return userAgent.split(" ")[0]?.split("/")[0];
+}
+const pkgManager = pkgManagerFromUserAgent(process.env.npm_config_user_agent);
+cli.run(args, binName, pkgManager);

packages/cli/node/index.d.ts

@@ -10,4 +10,5 @@
 export function run(
   args: Array<string>,
   binName?: string | undefined | null,
+  pkgManager?: string | undefined | null,
 ): void;

packages/cli/node/index.js

@@ -1,4 +1,10 @@
-const { existsSync, readFileSync } = require("fs");
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
 const { join } = require("path");
 
 const { platform, arch } = process;

packages/cli/node/src/lib.rs

@@ -4,6 +4,6 @@
 
 #[allow(unused)]
 #[napi_derive::napi]
-fn run(args: Vec<String>, bin_name: Option<String>) {
-    create_tauri_app::run(args, bin_name);
+fn run(args: Vec<String>, bin_name: Option<String>, pkg_manager: Option<String>) {
+    create_tauri_app::run(args, bin_name, pkg_manager);
 }

packages/cli/src/lib.rs

@@ -35,29 +35,36 @@ pub mod internal {
     }
 }
 
-pub fn run<I, A>(args: I, bin_name: Option<String>)
+pub fn run<I, A>(args: I, bin_name: Option<String>, detected_manager: Option<String>)
 where
     I: IntoIterator<Item = A>,
     A: Into<OsString> + Clone,
 {
-    if let Err(e) = try_run(args, bin_name) {
+    if let Err(e) = try_run(args, bin_name, detected_manager) {
         eprintln!("{BOLD}{RED}error{RESET}: {e:#}");
         exit(1);
     }
 }
 
-fn try_run<I, A>(args: I, bin_name: Option<String>) -> anyhow::Result<()>
+fn try_run<I, A>(
+    args: I,
+    bin_name: Option<String>,
+    detected_manager: Option<String>,
+) -> anyhow::Result<()>
 where
     I: IntoIterator<Item = A>,
     A: Into<OsString> + Clone,
 {
+    let detected_manager = detected_manager.and_then(|p| p.parse::<PackageManager>().ok());
     let args = cli::parse(args.into_iter().map(Into::into).collect(), bin_name)?;
     let defaults = cli::Args::default();
     let cli::Args {
         skip,
         mobile,
         alpha,
-        ..
+        manager,
+        project_name,
+        template,
     } = args;
     let cwd = std::env::current_dir()?;
 
@@ -74,7 +81,7 @@ where
 
     // Project name used for the project directory name
     // and if valid, it will also be used in Cargo.toml, Package.json ...etc
-    let project_name = args.project_name.unwrap_or_else(|| {
+    let project_name = project_name.unwrap_or_else(|| {
         if skip {
             defaults.project_name.unwrap()
         } else {
@@ -142,7 +149,7 @@ where
     };
 
     // Prompt for category if a package manger is not passed on the command line
-    let category = if args.manager.is_none() && !skip {
+    let category = if manager.is_none() && !skip {
         // Filter managers if a template is passed on the command line
         let managers = PackageManager::ALL.to_vec();
         let managers = args
@@ -158,11 +165,24 @@ where
 
         // Filter categories based on the detected package mangers
         let categories = Category::ALL.to_vec();
-        let categories = categories
+        let mut categories = categories
             .into_iter()
             .filter(|c| c.package_managers().iter().any(|p| managers.contains(p)))
             .collect::<Vec<_>>();
 
+        // sort categories so the most relevant category
+        // based on the auto-detected package manager is selected first
+        categories.sort_by(|a, b| {
+            detected_manager
+                .map(|p| b.package_managers().contains(&p))
+                .unwrap_or(false)
+                .cmp(
+                    &detected_manager
+                        .map(|p| a.package_managers().contains(&p))
+                        .unwrap_or(false),
+                )
+        });
+
         // If only one category is detected, skip prompt
         if categories.len() == 1 {
             Some(categories[0])
@@ -181,20 +201,28 @@ where
 
     // Package manager which will be used for rendering the template
     // and the after-render instructions
-    let pkg_manager = args.manager.unwrap_or_else(|| {
+    let pkg_manager = manager.unwrap_or_else(|| {
         if skip {
             defaults.manager.unwrap()
         } else {
             let category = category.unwrap();
-            let managers = category.package_managers();
+
+            let mut managers = category.package_managers().to_owned();
+            // sort managers so the auto-detected package manager is selected first
+            managers.sort_by(|a, b| {
+                detected_manager
+                    .map(|p| p == *b)
+                    .unwrap_or(false)
+                    .cmp(&detected_manager.map(|p| p == *a).unwrap_or(false))
+            });
 
             // If only one package manager is detected, skip prompt
             if managers.len() == 1 {
                 managers[0]
             } else {
                 let index = Select::with_theme(&ColorfulTheme::default())
                     .with_prompt("Choose your package manager")
-                    .items(managers)
+                    .items(&managers)
                     .default(0)
                     .interact()
                     .unwrap();
@@ -206,7 +234,7 @@ where
     let templates_no_flavors = pkg_manager.templates_no_flavors();
 
     // Template to render
-    let template = args.template.unwrap_or_else(|| {
+    let template = template.unwrap_or_else(|| {
         if skip {
             defaults.template.unwrap()
         } else {

packages/cli/src/main.rs

@@ -2,10 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-use std::{env::args_os, ffi::OsStr, path::Path, process::exit};
+use std::{env::args_os, ffi::OsStr, path::Path};
 
 fn main() {
     let mut args = args_os().peekable();
+    let mut is_cargo = false;
     let bin_name = match args
         .next()
         .as_deref()
@@ -14,6 +15,7 @@ fn main() {
         .and_then(OsStr::to_str)
     {
         Some("cargo-create-tauri-app") => {
+            is_cargo = true;
             if args.peek().and_then(|s| s.to_str()) == Some("create-tauri-app") {
                 // remove the extra cargo subcommand
                 args.next();
@@ -23,11 +25,12 @@ fn main() {
             }
         }
         Some(stem) => Some(stem.to_string()),
-        None => {
-            eprintln!("cargo-tauri wrapper unable to read first argument");
-            exit(1);
-        }
+        None => None,
     };
 
-    create_tauri_app::run(args, bin_name);
+    create_tauri_app::run(
+        args,
+        bin_name,
+        if is_cargo { Some("cargo".into()) } else { None },
+    );
 }