include goals looking for help

Author: Niko Matsakis

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

@@ -73,6 +73,10 @@ pub struct UpdatesGoal {
     /// True if the issue is closed.
     pub is_closed: bool,
 
+    /// If there are comments that include ["help wanted"](`rust_project_goals::re::HELP_WANTED`)
+    /// comments, those comments are included here.
+    pub help_wanted: Vec<HelpWanted>,
+
     /// Markdown with update text (bullet list)
     pub comments: Vec<ExistingGithubComment>,
 
@@ -88,3 +92,8 @@ pub struct UpdatesGoal {
     /// Contents of a "Why this goal?" section in the tracking issue (empty string if not present)
     pub why_this_goal: String,
 }
+
+#[derive(Serialize, Debug)]
+pub struct HelpWanted {
+    pub text: String,
+}

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

@@ -1,13 +1,14 @@
 use anyhow::Context;
 use chrono::{Datelike, NaiveDate};
 use rust_project_goals::markwaydown;
+use rust_project_goals::re::HELP_WANTED;
 use rust_project_goals::util::comma;
 use rust_project_goals_json::GithubIssueState;
 use std::io::Write;
 use std::path::Path;
 use std::process::{Command, Stdio};
 
-use crate::templates::{self, Updates, UpdatesGoal};
+use crate::templates::{self, HelpWanted, Updates, UpdatesGoal};
 use rust_project_goals::gh::issues::ExistingGithubIssue;
 use rust_project_goals::gh::{
     issue_id::{IssueId, Repository},
@@ -113,6 +114,9 @@ async fn prepare_goals(
         comments.sort_by_key(|c| c.created_at.clone());
         comments.retain(|c| !c.is_automated_comment() && filter.matches(c));
 
+
+        let help_wanted = help_wanted(&issue_id, issue)?;
+
         let why_this_goal = why_this_goal(&issue_id, issue)?;
 
         result.push(UpdatesGoal {
@@ -121,6 +125,7 @@ async fn prepare_goals(
             issue_assignees: comma(&issue.assignees),
             issue_url: issue_id.url(),
             progress,
+            help_wanted,
             is_closed: issue.state == GithubIssueState::Closed,
             num_comments: comments.len(),
             comments,
@@ -133,6 +138,43 @@ async fn prepare_goals(
     Ok(result)
 }
 
+fn help_wanted(
+    issue_id: &IssueId,
+    issue: &ExistingGithubIssue,
+) -> anyhow::Result<Vec<HelpWanted>> {
+    use std::fmt::Write;
+
+    let mut help_wanted = vec![];
+
+    for comment in &issue.comments {
+        let mut lines = comment.body.split('\n').peekable();
+
+        // Look for a line that says "Help wanted" at the front.
+        // Then extract the rest of that line along with subsequent lines until we find a blank line.
+        while lines.peek().is_some() {
+            while let Some(line) = lines.next() {
+                if let Some(c) = HELP_WANTED.captures(line) {
+                    help_wanted.push(HelpWanted {
+                        text: c["text"].to_string()
+                });
+                    break;
+                }
+            }
+
+            while let Some(line) = lines.next() {
+                if line.trim().is_empty() {
+                    break;
+                } else {
+                    let last = help_wanted.len() - 1;
+                    writeln!(&mut help_wanted[last].text, "{line}")?;
+                }
+            }
+        }
+    }
+
+    Ok(help_wanted)
+}
+
 fn why_this_goal(
     issue_id: &IssueId,
     issue: &ExistingGithubIssue,

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

@@ -100,3 +100,17 @@ pub fn is_just(re: &Regex, s: &str) -> bool {
     let output = re.replace(s, "X");
     output == "X"
 }
+
+lazy_static! {
+    /// If a line within a comment begins with this text, it will be considered a request for help
+    pub static ref HELP_WANTED: Regex =
+        Regex::new(r"^(Help wanted:|^**Help wanted:**) (?P<text>.*)")
+            .unwrap();
+}
+
+lazy_static! {
+    /// If a comment begins with this text, it will be considered a summary.
+    pub static ref TLDR: Regex =
+        Regex::new(r"^TLDR")
+            .unwrap();
+}

templates/updates.hbs

@@ -18,18 +18,41 @@ The Rust project is currently working towards a [slate of 26 project goals](http
 {{>goal_comments}}
 {{/each}}
 
-## Other goals
+## Goals looking for help
 
 {{#each other_goals}}
+{{#if help_wanted}}
 {{>introduce_goal}}
 
+{{#each help_wanted}}
+
+<!-- markdown separator --> 
+![Help wanted](https://img.shields.io/badge/Help%20wanted-yellow) {{{text}}}
 <!-- markdown separator --> 
 
+{{/each}}
+
 {{#if tldr}}
 {{tldr}}
 {{/if}}
 
 <!-- markdown separator --> 
 
 {{>goal_comments}}
+{{/if}}
+{{/each}}
+
+## Other goal updates
+
+{{#each other_goals}}
+{{#if help_wanted}}
+{{else}}
+{{>introduce_goal}}
+<!-- markdown separator --> 
+{{#if tldr}}
+{{tldr}}
+{{/if}}
+<!-- markdown separator --> 
+{{>goal_comments}}
+{{/if}}
 {{/each}}