use templates and revise output dramatically

Author: Niko Matsakis

mdbook-goals/src/gh/issues.rs

@@ -231,6 +231,8 @@ pub fn sync_assignees(
     }
 }
 
+pub const FLAGSHIP_LABEL: &str = "Flagship Goal";
+
 const LOCK_TEXT: &str = "This issue is intended for status updates only.\n\nFor general questions or comments, please contact the owner(s) directly.";
 
 impl ExistingGithubIssue {
@@ -247,7 +249,7 @@ impl ExistingGithubIssue {
 
     /// True if the issue has the label for a flagship goal.
     pub fn has_flagship_label(&self) -> bool {
-        self.has_label("flagship")
+        self.has_label(FLAGSHIP_LABEL)
     }
 }
 

mdbook-goals/src/json.rs

@@ -8,7 +8,7 @@
 
 use std::{path::PathBuf, str::FromStr};
 
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 
 use crate::{
     gh::{
@@ -92,15 +92,15 @@ struct TrackingIssue {
     state: ExistingIssueState,
 }
 
-#[derive(Serialize, Debug)]
+#[derive(Serialize, Deserialize, Debug)]
 pub enum Progress {
-    /// We could not find any checkboxes or other deatils on the tracking issue.
+    /// We could not find any checkboxes or other details on the tracking issue.
     /// So all we have is "open" or "closed".
     Binary {
         is_closed: bool,
     },
 
-    /// We found checkboxes or  issue listing.
+    /// We found checkboxes or issue listing.
     Tracked {
         completed: u32,
         total: u32,

mdbook-goals/src/main.rs

@@ -91,9 +91,15 @@ enum Command {
         /// Milestone for which we generate tracking issue data (e.g., `2024h2`).
         milestone: String,
 
-        /// File in which to generate the update summary.
-        /// The default is to generate a file named after the
-        /// milestone, e.g., `2024h2.md`).
+        /// Quick mode does not use an LLM to generate a summary.
+        #[structopt(long)]
+        quick: bool,
+
+        /// Quick mode does not use an LLM to generate a summary.
+        #[structopt(long)]
+        vscode: bool,
+
+        /// If specified, write the output into the given file.
         #[structopt(long)]
         output_file: Option<PathBuf>,
 
@@ -159,13 +165,17 @@ async fn main() -> anyhow::Result<()> {
             output_file,
             start_date,
             end_date,
+            quick,
+            vscode,
         } => {
             updates::updates(
                 &opt.repository,
                 milestone,
                 output_file.as_deref(),
                 start_date,
                 end_date,
+                *quick,
+                *vscode,
             )
             .await?;
         }

mdbook-goals/src/rfc.rs

@@ -12,7 +12,7 @@ use regex::Regex;
 use crate::{
     gh::{
         issue_id::{IssueId, Repository},
-        issues::{create_issue, list_issue_titles_in_milestone, lock_issue, sync_assignees},
+        issues::{create_issue, list_issue_titles_in_milestone, lock_issue, sync_assignees, FLAGSHIP_LABEL},
         labels::GhLabel,
     },
     goal::{self, GoalDocument, ParsedOwners, PlanItem, Status},
@@ -218,7 +218,7 @@ fn initialize_labels(
     });
 
     desired_labels.insert(GhLabel {
-        name: "Flagship Goal".to_string(),
+        name: FLAGSHIP_LABEL.to_string(),
         color: "5319E7".to_string(),
     });
 

mdbook-goals/src/templates.rs

@@ -25,19 +25,27 @@ impl<'h> Templates<'h> {
         assert!(reg.get_template("updates").is_some());
 
         reg.register_helper("markdown_to_html", Box::new(markdown_to_html));
+        reg.register_helper("is_complete", Box::new(is_complete));
 
         Ok(Templates { reg })
     }
 }
 
 handlebars::handlebars_helper!(markdown_to_html: |md: String| comrak::markdown_to_html(&md, &Default::default()));
 
+handlebars::handlebars_helper!(is_complete: |p: Progress| match p {
+    Progress::Binary { is_closed } => is_closed,
+    Progress::Tracked { completed, total } => completed == total,
+    Progress::Error { .. } => false,
+});
+
 /// The parameters expected by the `updates.md` template.
 #[derive(Serialize, Debug)]
 pub struct Updates {
     pub milestone: String,
     pub flagship_goals: Vec<UpdatesFlagshipGoal>,
-    pub other_goals: Vec<UpdatesOtherGoal>,
+    pub other_goals_with_updates: Vec<UpdatesOtherGoal>,
+    pub other_goals_without_updates: Vec<UpdatesOtherGoal>,
 }
 
 impl Updates {
@@ -47,6 +55,7 @@ impl Updates {
     }
 }
 
+/// Part of the parameters expected by the `updates.md` template.
 #[derive(Serialize, Debug)]
 pub struct UpdatesFlagshipGoal {
     /// Title of the tracking issue
@@ -61,13 +70,17 @@ pub struct UpdatesFlagshipGoal {
     /// URL of the tracking issue
     pub issue_url: String,
 
+    /// True if the issue is closed.
+    pub is_closed: bool,
+
     /// Progress towards the goal
     pub progress: Progress,
 
     /// Updates provided towards the goal
     pub updates: Vec<UpdatesFlagshipGoalUpdate>,
 }
 
+/// Part of the parameters expected by the `updates.md` template.
 #[derive(Serialize, Debug)]
 pub struct UpdatesFlagshipGoalUpdate {
     /// Username of the person who wrote the update
@@ -83,6 +96,7 @@ pub struct UpdatesFlagshipGoalUpdate {
     pub url: String,
 }
 
+/// Part of the parameters expected by the `updates.md` template.
 #[derive(Serialize, Debug)]
 pub struct UpdatesOtherGoal {
     /// Title of the tracking issue
@@ -97,6 +111,9 @@ pub struct UpdatesOtherGoal {
     /// URL of the tracking issue
     pub issue_url: String,
 
+    /// True if the issue is closed.
+    pub is_closed: bool,
+
     /// Markdown with update text (bullet list)
     pub updates_markdown: String,