todo 1.0.0

an Abbot package for Slack by Serious Business

A simple to-do app for your team

Abbot is a programmable bot that turns your team chat into a shared command center. We handle all the boilerplate of building and running these conmmands so that you can focus on making tools that help you ship faster.

We built Abbot because we saw the power of this style of work (called ChatOps), when we worked at GitHub. ChatOps made it possible for GitHub to work productively without meetings, while globally distributed. We think it's a pretty great way to work, so we made it easy to use in Slack, Discord, and Microsoft Teams.

You can read more about Abbot here, check out our blog, or take a look at some of the other cool packages available as a one-click install from Abbot's Package Directory.

To do lists are great, but they're even better when you can share them with your team.

This skill makes it easy to track todos right from chat.

Once it's installed, you can add your first todo by saying

@abbot todo buy some milk

Get a list of the items in your todo list by saying @abbot todo or @abbot todo list.

Items can be assigned to other teammates by saying @abbot todo assign 1 to @gandalf (assuming there's a #1 todo item, and user named gandalf in your chat.

Complete todos by saying @abbot complete 1, and see all the completed todos by saying @abbot todo completed. If there are items you want to remove from the list completely, say @abbot delete 1 to delete todo #1.

class Todo {
    public int Id { get; set; }
    public string Description { get; set; }
    public string AssignedTo { get; set; }
    public DateTime AssignedAt { get; set; }
    public string CreatedBy { get; set; }
    public DateTime CreatedAt { get; set; }
    public string CompletedBy {get; set; }
	public DateTime? CompletedAt { get; set; }	
}

var (cmd, idArg, _, assigneeArg) = Bot.Arguments;
var command = cmd is not IMissingArgument ? cmd.Value.ToUpperInvariant() : "LIST";

// This example uses one DB for everything, but you could create customized lists
// by changing the name here; for example you could set the dbname to match the room
// the script was called from.
string dbname = $"my-group-todo-list";
var db = await Bot.Brain.GetAsAsync<List<Todo>>(dbname);
if (db is null) {
    db = new List<Todo>();
    await Bot.ReplyAsync("no db for user found, creating one...");
    await SaveDb();
}

Task action = command switch {
    "LIST" => ListOpenTodos(),
    "COMPLETE" => CompleteTodo(idArg),
    "COMPLETED" => ListCompletedTodos(),
    "ASSIGN" => AssignTodo(idArg, assigneeArg),
    "DELETE" => DeleteTodo(idArg),
    _ => AddTodo(Bot.From.Id, Bot.Arguments.Value)
};
await action;

public async Task ListOpenTodos() {
    if (db.Count > 0) {
        var response = $"Here are all the open to-dos:";
        foreach (var item in db) {
            if (item.CompletedAt is null) {
                response += $"\n* #{item.Id}: {item.Description} (assigned to <@{item.AssignedTo}>)";
            }
        }
        await Bot.ReplyAsync(response);
    } else {
        await Bot.ReplyAsync("There aren't any open items to do. Try `@abbot todo help` to find out how to use this skill.");
    }
}

public async Task ListCompletedTodos() {
    if (db.Exists(t => t.CompletedAt.HasValue)) {
        var response = "Completed to-dos:";
        foreach (var item in db) {
            if (item.CompletedAt.HasValue) {
                response += $"\n * #{item.Id}: {item.Description} (completed by <@{item.CompletedBy}> at {item.CompletedAt}).";
            }
        }
        await Bot.ReplyAsync(response);
    } else {
        await Bot.ReplyAsync("Nobody has completed any items yet...");
    }
}

public async Task AddTodo(string owner, string description) {
    var todo = new Todo() {
        Id = db.Count + 1,
        Description = description,
        CreatedBy = owner,
        CreatedAt = DateTime.UtcNow,
        AssignedTo = owner,
        AssignedAt = DateTime.UtcNow,
        CompletedBy = string.Empty
    };
    
    db.Add(todo);
    await SaveDb();
    await Bot.ReplyAsync($"Added {todo.Id}: {description}");
}

public async Task CompleteTodo(IArgument idArg) {
    var id = idArg.ToInt32();
    if (id is null) {
        await Bot.ReplyAsync("COMPLETE expects a valid task number...");
        return;
    }
    
    var task = db.Find(t => t.Id == id.Value);

    if (task is not null) {
        task.CompletedAt = DateTime.Now;
        task.CompletedBy = Bot.From.Id;
        await SaveDb();
        await Bot.ReplyAsync($"Great, you completed item #{id}!");
    } else {
        await Bot.ReplyAsync($"Couldn't find a todo item #{id}");
    }
}

public async Task AssignTodo(IArgument idArg, IArgument assigneeArg) {
    var id = idArg.ToInt32();
    if (id is null) {
        await Bot.ReplyAsync("ASSIGN expects a valid task number (like `@abbot assign 3 to @gandalf`)");
        return;
    }
    if (assigneeArg is IMissingArgument) {
        await Bot.ReplyAsync($"You didn't say who to assign item ${id} to... (try something like `@abbot assign 3 to gandalf`)");
        return;
    }
    var task = db.Find(t => t.Id == id.Value);

    if (task is not null) {
        if (task.CompletedAt.HasValue) {
            await Bot.ReplyAsync($"Item #{id} has already been completed and can't be assigned.");
            return;
        }
        
        var assignee = assigneeArg switch {
            {Value: "me"} => Bot.From,
            IMentionArgument mentionArg => mentionArg.Mentioned,
            _ => null
        };
        if (assignee is null) {
            await Bot.ReplyAsync("I do not understand that assignee.");
            return;
        }
        
        task.AssignedAt = DateTime.Now;
        task.AssignedTo = assignee.Id;
        await SaveDb();
        await Bot.ReplyAsync($"Item #{id} is now assigned to {assignee}.");
    } else {
        await Bot.ReplyAsync($"Couldn't find a todo item #{id}.");
    }
}

public async Task DeleteTodo(IArgument idArg) {
    var id = idArg.ToInt32();
    if (id is null) {
        await Bot.ReplyAsync("DELETE expects a valid task number...");
        return;
    }
    var task = db.Find(t => t.Id == id.Value);
    db.Remove(task);
    await SaveDb();
    await Bot.ReplyAsync($"Deleted todo #{id}");
}

public async Task SaveDb() {
    await Bot.Brain.WriteAsync(dbname, db);
}

Version	Created	Author	Release Notes	Installs
1.0.0	6/10/2024	Paul	`@abbot todo release the todo package` `@abbot todo complete 1`	3

Sign in to add this to Slack You need an account to install this package with Abbot. Signing in with Slack will create an account if you don't have one already.

Not using Slack? No worries! Abbot works in Slack, Discord, and Microsoft Teams.

It's free to get started!

Details

Last updated: Thursday, 10 June 2024 16:34
Installs: 3 total installs
Language: CSharp
License: MIT License

?	Display shortcuts
Cmd+K	Display shortcuts when a form input has focus.
t	Jump to skill
ctrl+t	Jump to skill when a form input has focus.
Esc	Dismiss modal. Also used to remove focus from a text input to enable keyboard shortcut.
g m	Go to the My Bot page
g s	Go to the skills list
g p	Go to the package directory
g a	Go to the About page
g d	Go to the Docs site
g l	Go to Activity Log

About Abbot

README

Usage

Code

Version History

Details

Keyboard Shortcuts

Jump to Skill