feat: ✨ conditional form steps

Author: lucas-labs

coco.yml

@@ -45,7 +45,21 @@ theme:
   footer:fg: "#ffffff"
   footer:sec: "#000000"
 
+useEmoji: true
+askScope: false
+askBody: true
+askFooter: true
+askBreakingChange: true
+
 # scopes:
 #   - "source"
 #   - "meta"
-#   - "keyword"
+#   - "keyword"
+
+# types:
+#   - name: "feat"
+#     description: "A new feature"
+#     emoji: "✨"
+#   - name: "fix"
+#     description: "A bug fix"
+#     emoji: "🐛"

coco/src/cli/cfg.rs

@@ -1,2 +1,3 @@
 pub mod action;
+pub mod cfg;
 pub mod helpver;

coco/src/cli/mod.rs

@@ -26,7 +26,6 @@ async fn main() -> Result<()> {
     let action = get_action()?;
 
     match action {
-        Action::Help | Action::Version => handle_cli_action(action)?,
         Action::Coco(stage_check) => match git::list_staged(Some("./")) {
             Ok(staged) => {
                 if staged.is_empty() && stage_check {
@@ -65,6 +64,8 @@ async fn main() -> Result<()> {
             }
             Err(e) => println!("{}: {}", "Error listing staged files".red(), e),
         },
+        // Handle other actions
+        a => handle_cli_action(a)?,
     }
 
     Ok(())

coco/src/main.rs

@@ -8,6 +8,13 @@ use {
     },
 };
 
+// TODO: implement debug-only fps counter
+//       Create a small component that will be displayed in the bottom right corner of the screen
+//       and that will show the current FPS of the app. This will be useful to debug performance
+//       issues and to see how the app is performing in different scenarios.
+//
+//       it should only be displayed when the app is compiled in debug mode
+
 /// The global application status, which will be used to display different UIs based on the status.
 #[derive(Clone, Default, PartialEq)]
 #[allow(dead_code)]

coco/src/view/main_component.rs

@@ -3,11 +3,14 @@ mod commit;
 mod preview;
 mod scope;
 mod r#type;
+mod navigation {
+    pub mod form_step;
+}
 
 use {
     breaking::BreakingChangeStep,
     cc_core::{
-        config::Theme,
+        config::{CocoConfig, Theme},
         state::{MutexAppState, StepStatus},
     },
     commit::CommitStep,
@@ -16,74 +19,34 @@ use {
         ratatui::prelude::{Frame, Rect},
         Component, ComponentAccessors,
     },
+    navigation::form_step::FormStep,
     preview::PreviewStep,
     r#type::TypeStep,
     scope::ScopeStep,
-    strum::{Display, EnumString},
 };
 
-// TODO: conditional builder steps
-//       - use the config to determine which steps to show, by reading the ask_* fields
-//       - also, implement the missing `use_emoji` field, to be able to disable emojis in the
-//         generated commit messages
-
-#[derive(Default, EnumString, Display, PartialEq, Eq, Clone)]
-#[strum(serialize_all = "kebab-case")]
-enum FormStep {
-    #[default]
-    Type,
-    Scope,
-    Commit,
-    BreakingChange,
-    Preview,
-}
-
-impl FormStep {
-    fn next(&self) -> Option<Self> {
-        let next = match self {
-            Self::Type => Self::Scope,
-            Self::Scope => Self::Commit,
-            Self::Commit => Self::BreakingChange,
-            Self::BreakingChange => Self::Preview,
-            Self::Preview => return None,
-        };
-
-        Some(next)
-    }
-
-    fn prev(&self) -> Option<Self> {
-        let prev = match self {
-            Self::Type => return None,
-            Self::Scope => Self::Type,
-            Self::Commit => Self::Scope,
-            Self::BreakingChange => Self::Commit,
-            Self::Preview => Self::BreakingChange,
-        };
-
-        Some(prev)
-    }
-}
-
 component! {
     pub struct BuilderSection {
-        _theme: Theme,
         app_state: MutexAppState,
         current_step: FormStep,
+        config: CocoConfig,
     }
 }
 
 impl BuilderSection {
     pub fn new(theme: Theme, app_state: MutexAppState) -> Self {
+        let config = { app_state.lock().unwrap().config.clone() };
+
         Self {
-            _theme: theme.clone(),
             app_state: app_state.clone(),
             current_step: FormStep::Type,
+            config,
             children: children!(
                 "type" => TypeStep::new(theme.clone(), app_state.clone()).as_active(),
                 "scope" => ScopeStep::new(theme.clone(), app_state.clone()),
                 "commit" => CommitStep::new(theme.clone(), app_state.clone()),
                 "breaking-change" => BreakingChangeStep::new(theme.clone(), app_state.clone()),
-                "preview" => PreviewStep::new(theme.clone(), app_state.clone())
+                "preview" => PreviewStep::new(theme, app_state)
             ),
             ..Default::default()
         }
@@ -116,8 +79,8 @@ impl BuilderSection {
 impl Component for BuilderSection {
     fn receive_message(&mut self, message: String) {
         match message.as_str() {
-            "builder:next" => self.set_step(self.current_step.next()),
-            "builder:prev" => self.set_step(self.current_step.prev()),
+            "builder:next" => self.set_step(self.current_step.next(&self.config)),
+            "builder:prev" => self.set_step(self.current_step.prev(&self.config)),
             "builder:restart" => self.set_step(Some(FormStep::Type)),
             _ => {}
         }

coco/src/view/sections/builder.rs

@@ -0,0 +1,59 @@
+use cc_core::config::CocoConfig;
+use strum::{Display, EnumString};
+
+#[derive(Default, EnumString, Display, PartialEq, Eq, Clone)]
+#[strum(serialize_all = "kebab-case")]
+pub enum FormStep {
+    #[default]
+    Type,
+    Scope,
+    Commit,
+    BreakingChange,
+    Preview,
+}
+
+impl FormStep {
+    pub fn next(&self, config: &CocoConfig) -> Option<Self> {
+        let next = match self {
+            Self::Type => Self::Scope,
+            Self::Scope => Self::Commit,
+            Self::Commit => Self::BreakingChange,
+            Self::BreakingChange => Self::Preview,
+            Self::Preview => return None,
+        };
+
+        // if the next step is disabled by the config, skip it by going to the next one
+        if !is_step_enabled(&next, config) {
+            return next.next(config);
+        }
+
+        Some(next)
+    }
+
+    pub fn prev(&self, config: &CocoConfig) -> Option<Self> {
+        let prev = match self {
+            Self::Type => return None,
+            Self::Scope => Self::Type,
+            Self::Commit => Self::Scope,
+            Self::BreakingChange => Self::Commit,
+            Self::Preview => Self::BreakingChange,
+        };
+
+        // if the previous step is disabled by the config, skip it by going to the previous one
+        if !is_step_enabled(&prev, config) {
+            return prev.prev(config);
+        }
+
+        Some(prev)
+    }
+}
+
+fn is_step_enabled(step: &FormStep, config: &CocoConfig) -> bool {
+    match step {
+        FormStep::Type => true,
+        FormStep::Scope => config.ask_scope,
+        FormStep::Commit => true,
+        FormStep::BreakingChange => config.ask_breaking_change,
+        FormStep::Preview => true,
+    }
+}

coco/src/view/sections/builder/navigation/form_step.rs

@@ -100,7 +100,7 @@ fn ctype(name: &str, emoji: &str, description: &str) -> CommitKind {
     }
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct CocoConfig {
     pub theme: Theme,
     pub use_emoji: bool,