extract "why this goal" text from tracking issue

Author: Niko Matsakis

crates/rust-project-goals-cli-llm/src/templates.rs

@@ -81,4 +81,10 @@ pub struct UpdatesGoal {
 
     /// Progress towards the goal
     pub progress: Progress,
+
+    /// TL;DR comment (if any, empty string if none)
+    pub tldr: Option<String>,
+
+    /// Contents of a "Why this goal?" section in the tracking issue (empty string if not present)
+    pub why_this_goal: String,
 }

crates/rust-project-goals-cli-llm/src/updates.rs

@@ -1,5 +1,6 @@
 use anyhow::Context;
 use chrono::{Datelike, NaiveDate};
+use rust_project_goals::markwaydown;
 use rust_project_goals::util::comma;
 use rust_project_goals_json::GithubIssueState;
 use std::io::Write;
@@ -92,6 +93,11 @@ async fn prepare_goals(
             continue;
         }
 
+        let issue_id = IssueId {
+            repository: repository.clone(),
+            number: issue.number,
+        };
+
         let title = &issue.title;
 
         progress_bar::print_progress_bar_info(
@@ -107,26 +113,39 @@ async fn prepare_goals(
         comments.sort_by_key(|c| c.created_at.clone());
         comments.retain(|c| !c.is_automated_comment() && filter.matches(c));
 
+        let why_this_goal = why_this_goal(&issue_id, issue)?;
+
         result.push(UpdatesGoal {
             title: title.clone(),
             issue_number: issue.number,
             issue_assignees: comma(&issue.assignees),
-            issue_url: IssueId {
-                repository: repository.clone(),
-                number: issue.number,
-            }
-            .url(),
+            issue_url: issue_id.url(),
             progress,
             is_closed: issue.state == GithubIssueState::Closed,
             num_comments: comments.len(),
             comments,
+            tldr: None, // FIXME
+            why_this_goal,
         });
 
         progress_bar::inc_progress_bar();
     }
     Ok(result)
 }
 
+fn why_this_goal(
+    issue_id: &IssueId,
+    issue: &ExistingGithubIssue,
+) -> anyhow::Result<String> {
+    let sections = markwaydown::parse_text(issue_id.url(), &issue.body)?;
+    for section in sections {
+        if section.title == "Why this goal?" {
+            return Ok(section.text.trim().to_string());
+        }
+    }
+    return Ok("".to_string());
+}
+
 struct Filter<'f> {
     start_date: NaiveDate,
     end_date: &'f Option<NaiveDate>,

crates/rust-project-goals/src/markwaydown.rs

@@ -31,8 +31,14 @@ pub struct Table {
     pub rows: Vec<Vec<String>>,
 }
 
-pub fn parse(path: &Path) -> anyhow::Result<Vec<Section>> {
+pub fn parse(path: impl AsRef<Path>) -> anyhow::Result<Vec<Section>> {
+    let path = path.as_ref();
     let text = std::fs::read_to_string(path)?;
+    parse_text(path, &text)
+}
+
+pub fn parse_text(path: impl AsRef<Path>, text: &str) -> anyhow::Result<Vec<Section>> {
+    let path: &Path = path.as_ref();
     let mut result = vec![];
     let mut open_section = None;
     let mut open_table = None;
@@ -54,11 +60,14 @@ pub fn parse(path: &Path) -> anyhow::Result<Vec<Section>> {
             }
             CategorizeLine::TableRow(mut row) => {
                 if open_section.is_none() {
-                    anyhow::bail!(
-                        "{}:{}: markdowwn table outside of any section",
-                        path.display(),
-                        line_num
-                    );
+                    // create an "anonymous" section to house the table
+                    open_section = Some(Section {
+                        line_num,
+                        level: 0,
+                        title: String::new(),
+                        text: String::new(),
+                        tables: vec![],
+                    });
                 }
 
                 if let Some(table) = &mut open_table {

templates/updates.hbs

@@ -4,12 +4,32 @@ The Rust project is currently working towards a [slate of 26 project goals](http
 
 {{#each flagship_goals}}
 {{>introduce_goal}}
+
+<!-- markdown separator --> 
+
+**Why this goal?** {{why_this_goal}}
+
+{{#if tldr}}
+**What has happened?** {{tldr}}
+{{/if}}
+
+<!-- markdown separator --> 
+
 {{>goal_comments}}
 {{/each}}
 
 ## Other goals
 
 {{#each other_goals}}
 {{>introduce_goal}}
+
+<!-- markdown separator --> 
+
+{{#if tldr}}
+{{tldr}}
+{{/if}}
+
+<!-- markdown separator --> 
+
 {{>goal_comments}}
 {{/each}}