feat: add --identifier flag and prompt (#752)

Author: amrbashir

.changes/identifier.md

@@ -0,0 +1,7 @@
+---
+"create-tauri-app": "minor"
+"create-tauri-app-js": "minor"
+---
+
+Add `--identifier` flag and prompt to choose the identifier of your app.
+

src/args.rs

@@ -13,6 +13,7 @@ pub struct Args {
     pub project_name: Option<String>,
     pub manager: Option<PackageManager>,
     pub template: Option<Template>,
+    pub identifier: Option<String>,
     pub skip: bool,
     pub force: bool,
     pub rc: bool,
@@ -22,6 +23,7 @@ impl Default for Args {
     fn default() -> Self {
         Self {
             project_name: Some("tauri-app".to_string()),
+            identifier: Some("com.tauri.dev".to_string()),
             manager: Some(PackageManager::Npm),
             template: Some(Template::Vanilla),
             skip: false,
@@ -50,6 +52,7 @@ pub fn parse(argv: Vec<OsString>, bin_name: Option<String>) -> anyhow::Result<Ar
 {YELLOW}OPTIONS:{RESET}
   {GREEN}-m{RESET}, {GREEN}--manager <MANAGER>{RESET}       Specify preferred package manager [{managers}]
   {GREEN}-t{RESET}, {GREEN}--template <TEMPLATE>{RESET}     Specify the UI template to use [{templates}]
+                    {GREEN}--identifier <identifier>{RESET} Specify a unique identifier for your application
   {GREEN}-y{RESET}, {GREEN}--yes{RESET}                     Skip prompts and use defaults where applicable
   {GREEN}-f{RESET}, {GREEN}--force{RESET}                   Force create the directory even if it is not empty.
                     {GREEN}--rc{RESET}                      Bootstraps a project using tauri@2.0-rc.
@@ -101,6 +104,7 @@ pub fn parse(argv: Vec<OsString>, bin_name: Option<String>) -> anyhow::Result<Ar
         skip: pargs.contains(["-y", "--yes"]),
         force: pargs.contains(["-f", "--force"]),
         rc,
+        identifier: pargs.opt_value_from_str("--identifier")?,
         project_name: pargs.opt_free_from_str()?,
     };
 

src/lib.rs

@@ -10,7 +10,7 @@ use crate::{
     category::Category,
     deps::print_missing_deps,
     package_manager::PackageManager,
-    utils::{colors::*, theme::ColorfulTheme},
+    utils::{colors::*, dialoguer_theme::ColorfulTheme},
 };
 
 mod args;
@@ -71,6 +71,7 @@ where
         project_name,
         template,
         force,
+        identifier,
     } = args;
     let cwd = std::env::current_dir()?;
 
@@ -79,14 +80,15 @@ where
     let project_name = match project_name {
         Some(name) => name,
         None => {
+            let default = defaults
+                .project_name
+                .context("default project_name not set")?;
             if skip {
-                defaults
-                    .project_name
-                    .context("default project_name not set")?
+                default
             } else {
                 Input::<String>::with_theme(&ColorfulTheme::default())
                     .with_prompt("Project name")
-                    .default("tauri-app".into())
+                    .default(default)
                     .interact_text()?
                     .trim()
                     .into()
@@ -97,10 +99,10 @@ where
     let target_dir = cwd.join(&project_name);
 
     // Package name used in Cargo.toml, Package.json ...etc
-    let package_name = if is_valid_pkg_name(&project_name) {
+    let package_name = if utils::is_valid_pkg_name(&project_name) {
         project_name.clone()
     } else {
-        let valid_name = to_valid_pkg_name(&project_name);
+        let valid_name = utils::to_valid_pkg_name(&project_name);
         if skip {
             valid_name
         } else {
@@ -109,7 +111,7 @@ where
             .default(valid_name.clone())
             .with_initial_text(valid_name)
             .validate_with(|input: &String| {
-                if is_valid_pkg_name(input) {
+                if utils::is_valid_pkg_name(input) {
                     Ok(())
                 } else {
                     Err("Package name should only include lowercase alphanumeric character and hyphens \"-\" and doesn't start with numbers")
@@ -120,6 +122,23 @@ where
         }
     };
 
+    let identifier = match identifier {
+        Some(name) => name,
+        None => {
+            let default = format!("com.{package_name}.app");
+            if skip {
+                default
+            } else {
+                Input::<String>::with_theme(&ColorfulTheme::default())
+                    .with_prompt("Identifier")
+                    .default(default)
+                    .interact_text()?
+                    .trim()
+                    .into()
+            }
+        }
+    };
+
     // Confirm deleting the target project directory if not empty
     if target_dir.exists() && target_dir.read_dir()?.next().is_some() {
         let overwrite = if force {
@@ -303,7 +322,14 @@ where
     }
 
     // Render the template
-    template.render(&target_dir, pkg_manager, &project_name, &package_name, rc)?;
+    template.render(
+        &target_dir,
+        pkg_manager,
+        &project_name,
+        &package_name,
+        &identifier,
+        rc,
+    )?;
 
     // Print post-render instructions
     println!();
@@ -350,70 +376,3 @@ where
     println!();
     Ok(())
 }
-
-fn is_valid_pkg_name(project_name: &str) -> bool {
-    let mut chars = project_name.chars().peekable();
-    !project_name.is_empty()
-        && !chars.peek().map(|c| c.is_ascii_digit()).unwrap_or_default()
-        && !chars.any(|ch| !(ch.is_alphanumeric() || ch == '-' || ch == '_') || ch.is_uppercase())
-}
-
-fn to_valid_pkg_name(project_name: &str) -> String {
-    let ret = project_name
-        .trim()
-        .to_lowercase()
-        .replace([':', ';', ' ', '~'], "-")
-        .replace(['.', '\\', '/'], "");
-
-    let ret = ret
-        .chars()
-        .skip_while(|ch| ch.is_ascii_digit() || *ch == '-')
-        .collect::<String>();
-
-    if ret.is_empty() {
-        "tauri-app".to_string()
-    } else {
-        ret
-    }
-}
-
-#[cfg(test)]
-mod test {
-    use super::*;
-    #[test]
-    fn valiadtes_pkg_name() {
-        assert!(is_valid_pkg_name("tauri-app"));
-        assert!(is_valid_pkg_name("tauri_app"));
-        assert!(is_valid_pkg_name("t2auriapp"));
-        assert!(!is_valid_pkg_name("1tauriapp"));
-        assert!(!is_valid_pkg_name("tauri app"));
-        assert!(!is_valid_pkg_name("tauri:app"));
-        assert!(!is_valid_pkg_name("tauri.app"));
-        assert!(!is_valid_pkg_name("tauri/app"));
-        assert!(!is_valid_pkg_name("tauri\\app"));
-        assert!(!is_valid_pkg_name("tauri~app"));
-        assert!(!is_valid_pkg_name("Tauriapp"));
-    }
-
-    #[test]
-    fn converts_to_valid_pkg_name() {
-        assert_eq!(to_valid_pkg_name("tauri-app"), "tauri-app");
-        assert_eq!(to_valid_pkg_name("tauri_app"), "tauri_app");
-        assert_eq!(to_valid_pkg_name("t2auriapp"), "t2auriapp");
-        assert_eq!(to_valid_pkg_name("1tauriapp"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("123tauriapp"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("123-tauriapp"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("tauri app"), "tauri-app");
-        assert_eq!(to_valid_pkg_name("tauri:app"), "tauri-app");
-        assert_eq!(to_valid_pkg_name("tauri;app"), "tauri-app");
-        assert_eq!(to_valid_pkg_name("tauri.app"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("tauri/app"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("tauri\\app"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("tauri~app"), "tauri-app");
-        assert_eq!(to_valid_pkg_name("-tauri.app"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("-123tauri.app"), "tauriapp");
-        assert_eq!(to_valid_pkg_name("-2-123tau2ri-app-2"), "tau2ri-app-2");
-        assert_eq!(to_valid_pkg_name("1-2-3tau2ri-app2-"), "tau2ri-app2-");
-        assert_eq!(to_valid_pkg_name("Tauriapp"), "tauriapp");
-    }
-}

src/template.rs

@@ -10,7 +10,7 @@ use rust_embed::RustEmbed;
 use crate::{
     manifest::Manifest,
     package_manager::PackageManager,
-    utils::{colors::*, lte},
+    utils::{self, colors::*, lte},
 };
 
 const CTA_MANIFEST_FILENAME: &str = ".manifest";
@@ -256,6 +256,7 @@ impl<'a> Template {
         pkg_manager: PackageManager,
         project_name: &str,
         package_name: &str,
+        identifier: &str,
         rc: bool,
     ) -> anyhow::Result<()> {
         let manifest_bytes =
@@ -267,7 +268,7 @@ impl<'a> Template {
         let manifest = Manifest::parse(&manifest_str, rc)?;
 
         let lib_name = format!("{}_lib", package_name.replace('-', "_"));
-        let project_name_pascal_case = Self::transform_to_pascal_case(project_name.to_string());
+        let project_name_pascal_case = utils::to_pascal_case(project_name);
 
         let rc_str = rc.to_string();
         let manifest_template_data: HashMap<&str, &str> = [
@@ -276,6 +277,7 @@ impl<'a> Template {
             ("lib_name", &lib_name),
             ("package_name", package_name),
             ("project_name", project_name),
+            ("identifier", identifier),
             ("project_name_pascal_case", &project_name_pascal_case),
             (
                 "double_dash_with_space",
@@ -304,6 +306,7 @@ impl<'a> Template {
                 project_name_pascal_case.to_string(),
             ),
             ("package_name", package_name.to_string()),
+            ("identifier", identifier.to_string()),
             (
                 "before_dev_command",
                 lte::render(
@@ -460,22 +463,4 @@ impl<'a> Template {
 
         Ok(())
     }
-
-    fn transform_to_pascal_case(s: String) -> String {
-        let mut result = String::new();
-        let mut capitalize_next = false;
-        for (s, c) in s.chars().enumerate() {
-            if s == 0 {
-                result.push(c.to_ascii_uppercase());
-            } else if capitalize_next {
-                result.push(c.to_ascii_uppercase());
-                capitalize_next = false;
-            } else if ['_', '-'].contains(&c) {
-                capitalize_next = true;
-            } else {
-                result.push(c);
-            }
-        }
-        result
-    }
 }

src/utils/colors.rs

@@ -16,6 +16,7 @@ pub const ITALIC: &str = "\x1b[3m";
 pub const DIM: &str = "\x1b[2m";
 pub const DIMRESET: &str = "\x1b[22m";
 
+#[inline]
 pub fn remove_colors(s: &str) -> String {
     s.replace(BLACK, "")
         .replace(RED, "")

src/utils/theme.rs src/utils/dialoguer_theme.rssrc/utils/theme.rs renamed to src/utils/dialoguer_theme.rs

@@ -191,6 +191,7 @@ impl<'a> Iterator for Lexer<'a> {
     }
 }
 
+#[inline]
 fn is_truthy(value: &[u8]) -> bool {
     match value {
         TRUE => true,

src/utils/lte.rs

@@ -1,3 +1,95 @@
 pub mod colors;
+pub mod dialoguer_theme;
 pub mod lte;
-pub mod theme;
+
+pub fn is_valid_pkg_name(project_name: &str) -> bool {
+    let mut chars = project_name.chars().peekable();
+    !project_name.is_empty()
+        && !chars.peek().map(|c| c.is_ascii_digit()).unwrap_or_default()
+        && !chars.any(|ch| !(ch.is_alphanumeric() || ch == '-' || ch == '_') || ch.is_uppercase())
+}
+
+pub fn to_valid_pkg_name(project_name: &str) -> String {
+    let ret = project_name
+        .trim()
+        .to_lowercase()
+        .replace([':', ';', ' ', '~'], "-")
+        .replace(['.', '\\', '/'], "");
+
+    let ret = ret
+        .chars()
+        .skip_while(|ch| ch.is_ascii_digit() || *ch == '-')
+        .collect::<String>();
+
+    if ret.is_empty() {
+        "tauri-app".to_string()
+    } else {
+        ret
+    }
+}
+
+#[inline]
+pub fn to_pascal_case(s: &str) -> String {
+    let mut result = String::new();
+    let mut capitalize_next = false;
+    for (s, c) in s.chars().enumerate() {
+        if s == 0 {
+            result.push(c.to_ascii_uppercase());
+        } else if capitalize_next {
+            result.push(c.to_ascii_uppercase());
+            capitalize_next = false;
+        } else if ['_', '-'].contains(&c) {
+            capitalize_next = true;
+        } else {
+            result.push(c);
+        }
+    }
+    result
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+    #[test]
+    fn valiadtes_pkg_name() {
+        assert!(is_valid_pkg_name("tauri-app"));
+        assert!(is_valid_pkg_name("tauri_app"));
+        assert!(is_valid_pkg_name("t2auriapp"));
+        assert!(!is_valid_pkg_name("1tauriapp"));
+        assert!(!is_valid_pkg_name("tauri app"));
+        assert!(!is_valid_pkg_name("tauri:app"));
+        assert!(!is_valid_pkg_name("tauri.app"));
+        assert!(!is_valid_pkg_name("tauri/app"));
+        assert!(!is_valid_pkg_name("tauri\\app"));
+        assert!(!is_valid_pkg_name("tauri~app"));
+        assert!(!is_valid_pkg_name("Tauriapp"));
+    }
+
+    #[test]
+    fn converts_to_valid_pkg_name() {
+        assert_eq!(to_valid_pkg_name("tauri-app"), "tauri-app");
+        assert_eq!(to_valid_pkg_name("tauri_app"), "tauri_app");
+        assert_eq!(to_valid_pkg_name("t2auriapp"), "t2auriapp");
+        assert_eq!(to_valid_pkg_name("1tauriapp"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("123tauriapp"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("123-tauriapp"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("tauri app"), "tauri-app");
+        assert_eq!(to_valid_pkg_name("tauri:app"), "tauri-app");
+        assert_eq!(to_valid_pkg_name("tauri;app"), "tauri-app");
+        assert_eq!(to_valid_pkg_name("tauri.app"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("tauri/app"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("tauri\\app"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("tauri~app"), "tauri-app");
+        assert_eq!(to_valid_pkg_name("-tauri.app"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("-123tauri.app"), "tauriapp");
+        assert_eq!(to_valid_pkg_name("-2-123tau2ri-app-2"), "tau2ri-app-2");
+        assert_eq!(to_valid_pkg_name("1-2-3tau2ri-app2-"), "tau2ri-app2-");
+        assert_eq!(to_valid_pkg_name("Tauriapp"), "tauriapp");
+    }
+
+    #[test]
+    fn converts_to_pascal_case() {
+        assert_eq!(to_pascal_case("tauri-app"), "TauriApp");
+        assert_eq!(to_pascal_case("tau2ri-app"), "Tau2riApp");
+    }
+}

src/utils/mod.rs

@@ -1,7 +1,7 @@
 {
   "productName": "{% package_name %}",
   "version": "0.1.0",
-  "identifier": "com.tauri.dev",
+  "identifier": "{% identifier %}",
   "build": {
     {% if before_dev_command %}"beforeDevCommand": "{% before_dev_command %}",
     {% endif %}{% if dev_path %}"devUrl": "{% dev_path %}",