Update the readme since v2 broke a lot of options

Cargo.lock

@@ -173,7 +173,7 @@ checksum = "e496a50fda8aacccc86d7529e2c1e0892dbd0f898a6b5645b5561b89c3210efa"
 
 [[package]]
 name = "day-reporter"
-version = "1.4.0"
+version = "2.0.0"
 dependencies = [
  "anyhow",
  "chrono",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "day-reporter"
-version = "1.4.0"
+version = "2.0.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -4,6 +4,9 @@ A small program written in rust that digests my Things tasks into a format for S
 Tasks are pulled out of Things using AppleScript over a JavaScript OSA Bridge. Tasks are then filtered
 and formatted based on the selected format schema.
 
+## Options
+See `day-reporter -h` for a current list of options
+
 ## Basic Task format
 A task is returned as a markdown list element containing its title and optionally a list of information parsed from
 related tag sections in the notes portion of the task.
@@ -12,6 +15,16 @@ Tag specific additional bullets are included using a triple backtick (like GitHu
 specifying the coding style as you would (for example `typescript`) you specify the relevant tag: `MyTag`. Running the
 program with a given `--tags` argument will cause related tag blocks to be included as sub-bullets.
 
+### Example
+
+<pre>
+```MyTag
+Some notes
+```
+</pre>
+
+will result in "Some notes" being included with the task
+
 ## Name Sanitization
 Name tags found on projects and tasks are automatically sanitized by replacing vowel characters with lookalikes. This
 behavior can be disabled with the `--no-sanitize` argument.
@@ -23,8 +36,3 @@ and project specific matched tag block comments in the project notes.
 ## Area Formatting
 Areas collect up projects, but instead of indenting them further, Area's are returned as section titles above the
 generated output. If only one area contains all of the reported tasks, then the area name is omitted entirely.
-
-## Cycle Message Formatting
-The `--mode cycle` argument will output slightly different content. All tasks are collected at a project level, and
-only the project name is given. Cycle messages look back in time at the last 6 weeks and therefore have too many values
-to meaningfully output at full resolution.

src/main.rs

@@ -5,60 +5,42 @@ mod names;
 
 use reporter::{MarkdownReporter, Reporter, Resolution, ReportOptions};
 
-use things::task::{Task, Status};
+use things::task::Task;
 use anyhow::Result;
 use clap::{Parser, ValueEnum};
 
 #[derive(ValueEnum, Copy, Clone, Eq, PartialEq)]
-enum ReportTypes {
+enum ListType {
-    /// report projected work for the day and a morning message
+    /// Generate a report from the Things today list
-    Morning,
+    Today,
-    /// report what major tasks were completed in the last cycle.
+    /// Generate a report from the Things logbook
-    Cycle,
+    Logbook,
-    /// report what was actually done today and a signoff message
-    Signoff,
 }
 
-impl ReportTypes {
+impl ListType {
-    fn format_tasks(&self, tasks: Vec<Task>, tags: &Vec<String>, sanitize_names: bool) -> String {
+    fn format_tasks(&self, tasks: Vec<Task>, tags: &Vec<String>, sanitize_names: bool, resolution: Resolution) -> String {
         match self {
-            ReportTypes::Morning => {
+            ListType::Today => {
-                let task_report = MarkdownReporter.report(tasks, &ReportOptions {
+                MarkdownReporter.report(tasks, &ReportOptions {
-                    resolution: Resolution::FullTask,
+                    resolution,
                     tags: tags.to_vec(),
                     sanitize_names,
-                });
+                })
-                format!("{}\n\n{}", emoji::pick(3).join(" "), task_report)
             },
-            ReportTypes::Signoff => {
+            ListType::Logbook => {
-                let task_report = MarkdownReporter.report(tasks, &ReportOptions {
+                MarkdownReporter.report(tasks, &ReportOptions {
-                    resolution: Resolution::FullTask,
+                    resolution,
                     tags: tags.to_vec(),
                     sanitize_names,
-                });
+                })
-                format!("Stopping now\n\n{}", task_report)
-            },
-            ReportTypes::Cycle => {
-                let further_filtered = tasks.into_iter().filter(|t| {
-                    if let Some(p) = &t.project {
-                        return p.status == Status::Completed;
-                    }
-                    return false;
-                }).collect::<Vec<Task>>();
-                let task_report = MarkdownReporter.report(further_filtered, &ReportOptions {
-                    resolution: Resolution::Project,
-                    tags: tags.to_vec(),
-                    sanitize_names,
-                });
-                format!("*Cycle Report*\n\n{}", task_report)
             },
         }
     }
 }
 
-impl Default for ReportTypes {
+impl Default for ListType {
-    fn default() -> ReportTypes {
+    fn default() -> ListType {
-        ReportTypes::Morning
+        ListType::Today
     }
 }
 
@@ -76,23 +58,49 @@ struct CliArgs {
     omit: Vec<String>,
 
     /// Select the type of report to generate
-    #[arg(short, long, default_value_t = ReportTypes::default())]
+    #[arg(short, long, default_value_t = ListType::default())]
     #[clap(value_enum)]
-    report: ReportTypes,
+    list: ListType,
 
     /// By default, any @<name> style tags will be sanitized in the output to avoid @-mentions in
     /// Slack. This is done by replacing vowel characters with unicode lookalikes. If this
     /// flag is set then the names will be passed through unsanitized.
     #[arg(long, default_value_t = false)]
     no_sanitize: bool,
+
+    /// An ISO date string for when to filter tasks from.
+    /// Defaults to midnight this morning if unset. Not used for the today list
+    #[arg(long)]
+    from: Option<String>,
+
+    /// An ISO date string for when to filter tasks until.
+    /// Defaults to 1 second before midnight tonight if unset. Not used for the today list
+    #[arg(long)]
+    to: Option<String>,
+
+    /// An optional message to include at the beginning of the report. If omitted, 3 random emojis
+    /// will be included instead
+    #[arg(short, long)]
+    message: Option<String>,
+
+    /// Choose a resolution for the report. This will determine how much detail is included in the
+    /// output. Default is "FullTask"
+    #[arg(short, long, default_value_t = Resolution::default())]
+    #[clap(value_enum)]
+    resolution: Resolution,
 }
 
 fn main() -> Result<()> {
     let args = CliArgs::parse();
-    let tasks = match args.report {
+    let now = chrono::Local::now();
-        ReportTypes::Morning => Task::today(),
+    let from = args.from.unwrap_or_else(|| now.date().and_hms(0, 0, 0).to_rfc3339());
-        ReportTypes::Signoff => Task::logbook_today(),
+    let to = args.to.unwrap_or_else(|| (now + chrono::Duration::days(1)).date().and_hms(0, 0, 0).to_rfc3339());
-        ReportTypes::Cycle => Task::logbook_this_cycle(),
+
+    let message = args.message.unwrap_or_else(|| emoji::pick(3).join(" "));
+
+    let tasks = match args.list {
+        ListType::Today => Task::today(&from, &to),
+        ListType::Logbook => Task::logbook(&from, &to),
     }?;
     let mut reported: Vec<Task> = tasks.into_iter().filter(|task| {
         // Filter down to tasks with all selected tags and without any of the omitted tags
@@ -101,8 +109,8 @@ fn main() -> Result<()> {
     reported.sort_by(|a, b| {
         a.completion_date.cmp(&b.completion_date)
     });
-    let report = args.report.format_tasks(reported, &args.tags, !args.no_sanitize);
+    let report = args.list.format_tasks(reported, &args.tags, !args.no_sanitize, args.resolution);
-    println!("{report}");
+    println!("{message}\n\n{report}");
 
     Ok(())
 }

src/reporter.rs

@@ -1,3 +1,5 @@
+use clap::ValueEnum;
+
 use crate::things::task::{Task, Status};
 use crate::names::sanitize_names;
 
@@ -126,11 +128,18 @@ impl ThingsTree {
     }
 }
 
+#[derive(ValueEnum, Copy, Clone, Eq, PartialEq)]
 pub enum Resolution {
     FullTask,
     Project,
 }
 
+impl Default for Resolution {
+    fn default() -> Resolution {
+        Resolution::FullTask
+    }
+}
+
 pub struct ReportOptions {
     pub resolution: Resolution,
     pub tags: Vec<String>,

src/things/logbook.js

@@ -2,41 +2,36 @@ var things = Application("Things");
 var logbook = things.lists.byName("Logbook").toDos();
 var objs = [];
 
-var from = new Date();
+var from = new Date($params.from);
-from.setHours(0);
+var to = new Date($params.to);
-from.setMinutes(0);
-from.setSeconds(0);
-var to = new Date();
-to.setTime(from.getTime());
-to.setHours(23);
-to.setMinutes(59);
-to.setSeconds(59);
 
-logbook.filter(task => {
+for (const todo of logbook) {
-  return task.completionDate() >= from && task.completionDate() < to;
+  if(todo.completionDate() >= from && todo.completionDate() < to) {
-}).forEach(todo => {
+    var proj = todo.project();
-  var proj = todo.project();
+    var tags = [];
-  var tags = [];
+    if (proj) {
-  if (proj) {
+      tags.push(...proj.tagNames().split(', '));
-    tags.push(...proj.tagNames().split(', '));
+    }
+    var area = todo.area() || proj && proj.area();
+    objs.push({
+      id: todo.id(),
+      title: todo.name(),
+      notes: todo.notes() || null,
+      status: todo.status(),
+      completion_date: todo.completionDate(),
+      project: proj && {
+        id: proj.id(),
+        title: proj.name(),
+        status: proj.status(),
+        notes: proj.notes(),
+        tags: proj.tagNames().split(', '),
+      },
+      area: area && { id: area.id(), title: area.name() },
+      tags: [...tags, ...todo.tagNames().split(', ')].filter(t => t),
+    });
+  } else {
+    break;
   }
-  var area = todo.area() || proj && proj.area();
+}
-  objs.push({
-    id: todo.id(),
-    title: todo.name(),
-    notes: todo.notes() || null,
-    status: todo.status(),
-    completion_date: todo.completionDate(),
-    project: proj && {
-      id: proj.id(),
-      title: proj.name(),
-      status: proj.status(),
-      notes: proj.notes(),
-      tags: proj.tagNames().split(', '),
-    },
-    area: area && { id: area.id(), title: area.name() },
-    tags: [...tags, ...todo.tagNames().split(', ')].filter(t => t),
-  });
-});
 
 return JSON.stringify(objs, undefined, 2);

src/things/logbook_cycle.js

@@ -1,42 +0,0 @@
-var things = Application("Things");
-var logbook = things.lists.byName("Logbook").toDos();
-var objs = [];
-
-// From 6 weeks ago
-var from = new Date(new Date().getTime() - (6 * 7 * 24 * 60 * 60 * 1000));
-from.setHours(0);
-from.setMinutes(0);
-from.setSeconds(0);
-var to = new Date();
-to.setHours(23);
-to.setMinutes(59);
-to.setSeconds(59);
-
-logbook.filter(task => {
-  return task.completionDate() >= from && task.completionDate() < to;
-}).forEach(todo => {
-  var proj = todo.project();
-  var tags = [];
-  if (proj) {
-    tags.push(...proj.tagNames().split(', '));
-  }
-  var area = todo.area() || proj && proj.area();
-  objs.push({
-    id: todo.id(),
-    title: todo.name(),
-    notes: todo.notes() || null,
-    status: todo.status(),
-    completion_date: todo.completionDate(),
-    project: proj && {
-      id: proj.id(),
-      title: proj.name(),
-      status: proj.status(),
-      notes: proj.notes(),
-      tags: proj.tagNames().split(', '),
-    },
-    area: area && { id: area.id(), title: area.name() },
-    tags: [...tags, ...todo.tagNames().split(', ')].filter(t => t),
-  });
-});
-
-return JSON.stringify(objs, undefined, 2);

src/things/task.rs

@@ -1,5 +1,5 @@
 use std::str::from_utf8;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 use anyhow::Result;
 use osascript;
 use serde_json;
@@ -44,27 +44,31 @@ pub struct Task {
     pub area: Option<Area>,
 }
 
+#[derive(Serialize, Debug)]
+pub struct TaskParams {
+    // ISO string for the start date
+    from: String,
+    // ISO string for the end date
+    to: String,
+}
+
 impl Task {
     /// A Helper for loading Tasks from json returned by an osascript
-    fn from_script(script_bytes: &[u8]) -> Result<Vec<Task>> {
+    fn from_script(script_bytes: &[u8], params: TaskParams) -> Result<Vec<Task>> {
         let script = osascript::JavaScript::new(from_utf8(script_bytes)?);
-        let raw_json: String = script.execute()?;
+        let raw_json: String = script.execute_with_params(params)?;
         let tasks: Vec<Task> = serde_json::from_str(&raw_json)?;
         Ok(tasks)
     }
 
     /// Get all tasks in the today list from Things
-    pub fn today() -> Result<Vec<Task>> {
+    pub fn today(from: &String, to: &String) -> Result<Vec<Task>> {
-        Task::from_script(include_bytes!("today.js"))
+        Task::from_script(include_bytes!("today.js"), TaskParams { from: from.to_string(), to: to.to_string() })
     }
 
     /// Get all tasks in the logbook list from Things
-    pub fn logbook_today() -> Result<Vec<Task>> {
+    pub fn logbook(from: &String, to: &String) -> Result<Vec<Task>> {
-        Task::from_script(include_bytes!("logbook.js"))
+        Task::from_script(include_bytes!("logbook.js"), TaskParams { from: from.to_string(), to: to.to_string() })
-    }
-
-    pub fn logbook_this_cycle() -> Result<Vec<Task>> {
-        Task::from_script(include_bytes!("logbook_cycle.js"))
     }
 
     pub fn has_tag(&self, tag: &str) -> bool {