merge proposed,orphaned and document plugin a bit

Author: nikomatsakis

mdbook-goals/src/mdbook_preprocessor.rs

@@ -177,17 +177,21 @@ impl<'c> GoalPreprocessorWithContext<'c> {
             return Ok(());
         };
         let range = m.get(0).unwrap().range();
-        let status = Status::try_from(&m[1])?;
+        let statuses = m[1]
+            .split(',')
+            .map(|s| s.trim())
+            .map(Status::try_from)
+            .collect::<anyhow::Result<Vec<Status>>>()?;
 
         let Some(chapter_path) = &chapter.path else {
             anyhow::bail!("found `<!-- GOALS -->` but chapter has no path")
         };
 
         // Extract out the list of goals with the given status.
         let goals = self.goal_documents(chapter_path)?;
-        let mut goals_with_status: Vec<&GoalDocument> = goals
+        let mut goals_with_status: Vec<&GoalDocument> = statuses
             .iter()
-            .filter(|g| g.metadata.status == status)
+            .flat_map(|&status| goals.iter().filter(move |g| g.metadata.status == status))
             .collect();
 
         goals_with_status.sort_by_key(|g| &g.metadata.title);

mdbook-goals/src/re.rs

@@ -6,7 +6,7 @@ lazy_static! {
 }
 
 lazy_static! {
-    pub static ref GOAL_LIST: Regex = Regex::new(r"<!-- GOALS `(.*)` -->").unwrap();
+    pub static ref GOAL_LIST: Regex = Regex::new(r"<!-- GOALS '(.*)' -->").unwrap();
 }
 
 lazy_static! {

src/2024h2/README.md

@@ -87,13 +87,13 @@ The flagship goals proposed for this roadmap are as follows:
 
 The slate of additional project goals are as follows. These goals all have identified owners who will drive the work forward as well as a viable work plan. The goals include asks from the listed Rust teams, which are cataloged in the [reference-level explanation](#reference-level-explanation) section below. Some goals are actively looking for volunteers; these goals are tagged with ![Help wanted][].
 
-<!-- GOALS `Proposed` -->
+<!-- GOALS 'Proposed' -->
 
 ### Orphaned goals ![Help wanted][]
 
 Goals in this section are "pre-approved" by the team but lack an owner. These indicate a place where we are looking for someone to step up and help drive the goal the goal to completion. Every orphaned goal has someone who is willing and able to serve as mentor, but lacks the time or resources to truly *own* the goal. If you are interested in serving as the owner for one of these orphaned goals, reach out to the listed mentor to discuss. Orphaned goals may also be used as the basis of applying for grants from the Rust Foundation or elsewhere.
 
-<!-- GOALS `Orphaned` -->
+<!-- GOALS 'Orphaned' -->
 
 # Reference-level explanation
 [reference-level-explanation]: #reference-level-explanation

src/2024h2/flagship.md

@@ -1,3 +1,3 @@
 # Flagship goals
 
-<!-- GOALS `Flagship` -->
+<!-- GOALS 'Flagship' -->

src/2024h2/not_accepted.md

@@ -2,4 +2,4 @@
 
 This section contains goals that were proposed but ultimately not accepted, either for want of resources or consensus. In many cases, narrower versions of these goals were accepted.
 
-<!-- GOALS `Not accepted` -->
+<!-- GOALS 'Not accepted' -->

src/2024h2/orphaned.md

@@ -2,6 +2,6 @@
 
 Goals in this section are "pre-approved" by the team but lack an owner. These indicate a place where we are looking for someone to step up and help drive the goal the goal to completion. Every orphaned goal has someone who is willing and able to serve as mentor, but lacks the time or resources to truly *own* the goal. If you are interested in serving as the owner for one of these orphaned goals, reach out to the listed mentor to discuss. Orphaned goals may also be used as the basis of applying for grants from the Rust Foundation or elsewhere.
 
-<!-- GOALS `Orphaned` -->
+<!-- GOALS 'Orphaned' -->
 
 

src/2024h2/proposed.md

@@ -2,6 +2,8 @@
 
 This page lists the goals currently under consideration, with the exception of [flagship goals](./flagship.md), which are listed separately.
 
-<!-- GOALS `Proposed` -->
+Some goals here are listed without an owner (look for the ![Help wanted][] badge). These indicate a place where we are looking for someone to step up and help drive the goal the goal to completion. Every orphaned goal has someone who is willing and able to serve as mentor, but lacks the time or resources to truly *own* the goal. If you are interested in serving as the owner for one of these orphaned goals, reach out to the listed mentor to discuss.
+
+<!-- GOALS 'Proposed,Orphaned' -->
 
 

src/SUMMARY.md

@@ -7,7 +7,6 @@
 - [RFC draft](./2024h2/README.md)
 - [Flagship goals](./2024h2/flagship.md)
 - [Proposed goals](./2024h2/proposed.md)
-- [Orphaned goals](./2024h2/orphaned.md)
 - [Goals not accepted](./2024h2/not_accepted.md)
 - [General notes](./2024h2/notes.md)
 

src/admin/commands.md

@@ -0,0 +1,5 @@
+# Commands
+
+The `mdbook-goals` plugin can also be run with `cargo run --` and it has a number of useful commands:
+
+* `cargo run -- --help`

src/admin/mdbook_plugin.md

@@ -0,0 +1,47 @@
+# Mdbook Plugin
+
+The mdbook is controlled by the `mdbook-goals` plugin in this repo.
+This plugin makes various edits to the source:
+
+* Linking usernames like `@foo` to their github page and replacing them with their display name.
+* Linking GH references lke rust-lang/rust#123.
+* Collating goals, creating tables, etc.
+
+The plugin can also be used [from the commmand line](./commands.md).
+
+## Expected book structure
+
+The plugin is designed for the book to have a directory per phase of the goal program, e.g., `src/2024h2`, `src/2025h1`, etc.
+Within this directory there should be:
+
+* A `README.md` file that will contain the draft slate RFC.
+* One file per goal. Each goal file must follow the [TEMPLATE](../TEMPLATE.md) structure and in particular must have
+    * a metadata table in its first section
+    * a [Summary section](../TEMPLATE.md#summary)
+    * a [Ownership and team asks](../TEMPLATE.md#ownership-and-team-asks) containing the subgoal table
+* One file per "phase" of the program, e.g., `proposed.md` etc. (These are not mandatory.)
+
+## Plugin replacement text
+
+The plugin will replace the following placeholder texts.
+Each placeholder is enclosed within an html comment `<!-- -->`.
+
+### Goal count
+
+The placeholder `<!-- #GOALS -->` will be replaced with the total number of goals under consideration
+(this count excludes goals with the status `Not accepted`).
+
+### Goal listing
+
+The placeholder `<!-- GOALS '$Status' -->` will insert a goal table listing goals of the given status `$Status`, e.g.: 
+
+```
+<!-- GOALS 'Flagship' -->
+<!-- GOALS 'Proposed' -->
+```
+
+You can also list multiple status items, e.g.:
+
+```
+<!-- GOALS 'Accepted,Orphaned' -->
+```