# Planner

[![CI](https://github.com/revuniversal/planner/actions/workflows/cargo.yml/badge.svg)](https://github.com/revuniversal/planner/actions/workflows/cargo.yml)

A planning app to help me get my shit together, written in rust.

## Motivation

I've been creating a markdown(ish) plan file everyday for several years. I use a naming convention similar to `{yyyy}.{MM}.{dd}.plan.md`, and on most days I create my plan by copying the previous day's plan, then changing the day/date, and amending the schedule.

In my experience, creating my plan by hand each day gives me more agency than allowing a tool to create it for me. However, this is subject to human error, and often results in mismatches between the name of the plan files and the content. It also makes it more difficult to track over time.

## Installation

```console
foo@bar:~$ cargo install planner
```

> To use cargo install, you'll need to [install Rust](https://www.rust-lang.org/tools/install).

## Usage

### Default

```console
foo@bar:~$ planner
```

Opens today's plan in vim. If today's plan doesn't exist, then it will be created by copying the most recent plan. If no plan exists, then an empty plan will be created.

### Help

```sh
foo@bar:~$ planner --help
```

## TODOs

- [ ] Add unit tests for PlanDirectory, PlanFile
- [ ] Add unit tests for schedule parsing
- [ ] Add note parsing with unit tests
- [ ] Configuration
  - [ ] Allow users to change editor preferences (not everybody loves vim).
- [ ] Subcommand: `review`: Review plan
  - [ ] Arg: `today` (default) - show what's been today
  - [ ] Arg: `yesterday` - Show what was done yesterday
  - [ ] Arg: `week` - Show data from the week so far (starting on Monday)
  - [ ] Arg: `last-week` - Show data from the last completed week (starting on Monday)
  - [ ] Arg: `month` - Show data from the month so far (starting on the 1st)
  - [ ] Arg: `since (date|weekday)` - Show data from all plans sinnce the specified day
        or date
- [x] On plan copy
  - [x] Update day/date header so it matches the filename
  - [x] Clean the TaskList section (remove completed tasks)
  - [x] Clean the Schedule section (remove the actual schedule events)
  - [x] Clean the notes section (delete the notes)