chore: Change variable names, add comments, add file extension to todo states

Updates:
- Todo list state files now have ".json" extensions

Author: kiran-garre

crates/chat-cli/src/cli/agent/mod.rs

@@ -728,6 +728,7 @@ impl Agents {
             "use_aws" => "trust read-only commands".dark_grey(),
             "report_issue" => "trusted".dark_green().bold(),
             "thinking" => "trusted (prerelease)".dark_green().bold(),
+            "todo_list" => "trusted".dark_green().bold(),
             _ if self.trust_all_tools => "trusted".dark_grey().bold(),
             _ => "not trusted".dark_grey(),
         };

crates/chat-cli/src/cli/chat/cli/todos.rs

@@ -7,14 +7,19 @@ use crossterm::style::{
 use dialoguer::FuzzySelect;
 use eyre::Result;
 
-use crate::cli::chat::tools::todo::TodoState;
+use crate::cli::chat::tools::todo::{
+    TodoListState,
+    delete_todo,
+    get_all_todos,
+};
 use crate::cli::chat::{
     ChatError,
     ChatSession,
     ChatState,
 };
 use crate::os::Os;
 
+/// Defines subcommands that allow users to view and manage todo lists
 #[derive(Debug, PartialEq, Subcommand)]
 pub enum TodoSubcommand {
     /// Delete all completed to-do lists
@@ -62,15 +67,15 @@ impl TodoSubcommand {
     pub async fn execute(self, os: &mut Os, session: &mut ChatSession) -> Result<ChatState, ChatError> {
         match self {
             Self::ClearFinished => {
-                let (todos, errors) = match TodoState::get_all_todos(os).await {
+                let (todos, errors) = match get_all_todos(os).await {
                     Ok(res) => res,
                     Err(e) => return Err(ChatError::Custom(format!("Could not get to-do lists: {e}").into())),
                 };
                 let mut cleared_one = false;
 
                 for todo_status in todos.iter() {
                     if todo_status.completed.iter().all(|b| *b) {
-                        match TodoState::delete_todo(os, &todo_status.id).await {
+                        match delete_todo(os, &todo_status.id).await {
                             Ok(_) => cleared_one = true,
                             Err(e) => {
                                 return Err(ChatError::Custom(format!("Could not delete to-do list: {e}").into()));
@@ -119,7 +124,7 @@ impl TodoSubcommand {
                         execute!(session.stderr, style::Print("No to-do lists to view!\n"))?;
                     } else if let Some(index) = fuzzy_select_todos(&entries, "Select a to-do list to view:") {
                         if index < entries.len() {
-                            let list = TodoState::load(os, &entries[index].id).await.map_err(|e| {
+                            let list = TodoListState::load(os, &entries[index].id).await.map_err(|e| {
                                 ChatError::Custom(format!("Could not load current to-do list: {e}").into())
                             })?;
                             execute!(
@@ -145,14 +150,14 @@ impl TodoSubcommand {
                         execute!(session.stderr, style::Print("No to-do lists to delete!\n"))?;
                     } else if all {
                         for entry in entries {
-                            TodoState::delete_todo(os, &entry.id)
+                            delete_todo(os, &entry.id)
                                 .await
                                 .map_err(|_e| ChatError::Custom("Could not delete all to-do lists".into()))?;
                         }
                         execute!(session.stderr, style::Print("✔ Deleted all to-do lists!\n".green()),)?;
                     } else if let Some(index) = fuzzy_select_todos(&entries, "Select a to-do list to delete:") {
                         if index < entries.len() {
-                            TodoState::delete_todo(os, &entries[index].id).await.map_err(|e| {
+                            delete_todo(os, &entries[index].id).await.map_err(|e| {
                                 ChatError::Custom(format!("Could not delete the selected to-do list: {e}").into())
                             })?;
                             execute!(
@@ -174,7 +179,7 @@ impl TodoSubcommand {
     /// Convert all to-do list state entries to displayable entries
     async fn get_descriptions_and_statuses(os: &Os) -> Result<Vec<TodoDisplayEntry>> {
         let mut out = Vec::new();
-        let (todos, _) = TodoState::get_all_todos(os).await?;
+        let (todos, _) = get_all_todos(os).await?;
         for todo in todos.iter() {
             out.push(TodoDisplayEntry {
                 num_completed: todo.completed.iter().filter(|b| **b).count(),

crates/chat-cli/src/cli/chat/mod.rs

@@ -131,7 +131,7 @@ use crate::api_client::{
 };
 use crate::auth::AuthError;
 use crate::auth::builder_id::is_idc_user;
-use crate::cli::TodoState;
+use crate::cli::TodoListState;
 use crate::cli::agent::Agents;
 use crate::cli::chat::cli::SlashCommand;
 use crate::cli::chat::cli::prompts::{
@@ -655,7 +655,7 @@ impl ChatSession {
         // Create for cleaner error handling for todo lists
         // This is more of a convenience thing but is not required, so the Result
         // is ignored
-        let _ = TodoState::init_dir(os).await;
+        let _ = TodoListState::init_dir(os).await;
 
         Ok(Self {
             stdout,
@@ -2802,7 +2802,7 @@ impl ChatSession {
     pub async fn resume_todo_request(&mut self, os: &mut Os, id: &str) -> Result<ChatState, ChatError> {
         // Have to unpack each value separately since Reports can't be converted to
         // ChatError
-        let todo_list = match TodoState::load(os, id).await {
+        let todo_list = match TodoListState::load(os, id).await {
             Ok(todo) => todo,
             Err(e) => {
                 return Err(ChatError::Custom(format!("Error getting todo list: {e}").into()));

crates/chat-cli/src/cli/chat/prompt.rs

@@ -83,6 +83,11 @@ pub const COMMANDS: &[&str] = &[
     "/save",
     "/load",
     "/subscribe",
+    "/todos",
+    "/todos resume",
+    "/todos clear-finished",
+    "/todos view",
+    "/todos delete",
 ];
 
 /// Complete commands that start with a slash

crates/chat-cli/src/cli/chat/tool_manager.rs

@@ -79,7 +79,7 @@ use crate::cli::chat::tools::fs_write::FsWrite;
 use crate::cli::chat::tools::gh_issue::GhIssue;
 use crate::cli::chat::tools::knowledge::Knowledge;
 use crate::cli::chat::tools::thinking::Thinking;
-use crate::cli::chat::tools::todo::TodoInput;
+use crate::cli::chat::tools::todo::TodoList;
 use crate::cli::chat::tools::use_aws::UseAws;
 use crate::cli::chat::tools::{
     Tool,
@@ -1067,7 +1067,7 @@ impl ToolManager {
             "report_issue" => Tool::GhIssue(serde_json::from_value::<GhIssue>(value.args).map_err(map_err)?),
             "thinking" => Tool::Thinking(serde_json::from_value::<Thinking>(value.args).map_err(map_err)?),
             "knowledge" => Tool::Knowledge(serde_json::from_value::<Knowledge>(value.args).map_err(map_err)?),
-            "todo_list" => Tool::Todo(serde_json::from_value::<TodoInput>(value.args).map_err(map_err)?),
+            "todo_list" => Tool::Todo(serde_json::from_value::<TodoList>(value.args).map_err(map_err)?),
             // Note that this name is namespaced with server_name{DELIMITER}tool_name
             name => {
                 // Note: tn_map also has tools that underwent no transformation. In otherwords, if

crates/chat-cli/src/cli/chat/tools/mod.rs

@@ -36,7 +36,7 @@ use serde::{
     Serialize,
 };
 use thinking::Thinking;
-use todo::TodoInput;
+use todo::TodoList;
 use tracing::error;
 use use_aws::UseAws;
 
@@ -81,7 +81,7 @@ pub enum Tool {
     GhIssue(GhIssue),
     Knowledge(Knowledge),
     Thinking(Thinking),
-    Todo(TodoInput),
+    Todo(TodoList),
 }
 
 impl Tool {