@mark1russell7/site-pages 0.1.0 → 0.1.2

package/README.md

@@ -76,6 +76,10 @@ The kind of a version:
 
 ## The status
 
+The command reads two forms of a roadmap file. It reads both forms in one file, and it keeps the items in the order of the file.
+
+### The tables
+
 The command reads each Markdown table of the roadmap file with an `ID` column and a `Status` column. Each row is one item, and the heading above the table is its section. The header names match without case.
 
 | Column | Use |
@@ -95,10 +99,40 @@ The classes, in the sequence of the page:
 | `progress` | in progress, active, ongoing, started, wip |
 | `open` | not started, to do, and a status without a keyword |
 | `later` | later, deferred, postponed, someday |
-| `done` | done, shipped, merged, fixed, released, complete, closed |
+| `done` | done, shipped, merged, fixed, released, complete, closed, dropped, cancelled, wontfix, and the word in `## Never` |
 
 A row whose cells do not match the header stops the build with the file and the line. Thus the page does not lose an item without a message.
 
+### The item headings
+
+The command also reads each heading `` ### `id`: Title `` under a `##` heading. The `##` heading is the section and the status of its items, for example `## Waiting on Mark`, `## Later` or `## Shipped`. A dash can replace the colon.
+
+```md
+## Waiting on Mark
+
+### `eval-b`: Eval, part B
+
+- Area: Site and growth
+- Waits for: `eval`
+- [crawler #22](https://github.com/acme/crawler/pull/22)
+```
+
+The command also reads the heading `### S1 · Title`: the ID is one word before the middle dot. A list item `Status:` gives the status of its item, and it wins over the `##` heading.
+
+```md
+### S1 · Detection and divergence in Docker
+
+- **Status:** in progress
+- **Area:** program
+- **Depends on:** S0
+- **Links:** [The results](https://example.com/results/)
+```
+
+- The list items `Area:`, `Owner:` and `Waits for:` (or `Depends on:`) give the optional fields. A label can be bold.
+- The list item `Links:` and the other list items give the links: Markdown links, `#12`, `PR #12` and commit hashes in code spans.
+- A `###` heading without an ID is not an item. A heading without a `##` heading above it and without a `Status:` item is not an item either. The text of an item is not read.
+- A roadmap without a table and without an item heading stops the build.
+
 The GitHub part comes from one GraphQL request: the 50 open pull requests and the 50 open issues that changed last, with the totals.
 
 ## The data shapes

package/build/{build-vAps0mRE.js → build-CDw3NHWL.js}

@@ -851,8 +851,10 @@ async function readReleases(options) {
 * The status data: the open work of a roadmap file, and the open pull requests and issues of a
 * GitHub repository. The build reads both, so the page shows the state at the time of the build.
 *
-* @remarks The roadmap parser reads each Markdown table with an `ID` column and a `Status` column.
-* It is strict: a row whose cells do not match the header stops the build with the file and the line.
+* @remarks The roadmap parser reads two forms. The first form is each Markdown table with an `ID`
+* column and a `Status` column. The second form is each heading "### `id`: Title" under a "##" heading
+* that gives the status. The parser is strict: a row whose cells do not match the header stops the
+* build with the file and the line.
 */
 /** The classes of a status, in the sequence of the board. The open work comes first. */
 const STATUS_CLASSES = [
@@ -875,7 +877,7 @@ const OPEN_CLASSES = [
 var RoadmapParseError = class extends Error {};
 const STATUS_KEYWORDS = [
 	["open", /\bnot\s+(?:yet\s+)?(?:started|done|fixed|merged|shipped|released)\b|\bto[ -]?do\b/],
-	["done", /\b(?:done|shipped|merged|fixed|released|complete|completed|closed)\b/],
+	["done", /\b(?:done|shipped|merged|fixed|released|complete|completed|closed|never|dropped|cancell?ed|wontfix)\b|\bwon't do\b/],
 	["progress", /\bin[ -]progress\b|\b(?:active|ongoing|started|wip)\b/],
 	["waiting", /\b(?:waiting|waits|awaiting|needs)\b/],
 	["blocked", /\bblocked\b/],
@@ -1033,12 +1035,99 @@ function linksOf(cell, options = {}) {
 	}
 	return links;
 }
+/** The heading of an item: "### `id`: Title". A dash can take the place of the colon. */
+const ITEM_HEADING = /^###\s+`([^`]+)`\s*[:–—-]\s*(.*?)\s*#*\s*$/;
+/** The other heading of an item: "### S1 · Title". The ID is one word before the middle dot. */
+const ITEM_HEADING_DOT = /^###\s+([A-Za-z0-9][\w.-]*)\s+·\s+(.*?)\s*#*\s*$/;
 /**
-* This function gives the items of a roadmap file: one item for each row of each table with an `ID`
-* column and a `Status` column. The header names match without case.
+* A field of an item heading: "- Area: Docs", "- **Area:** Docs" or "- **Area**: Docs". The label
+* matches without case.
+*/
+const ITEM_FIELD = /^\s*[-*]\s+(\*\*|__)?([A-Za-z][A-Za-z ]*?)(?::\1|\1:)\s*(.*)$/;
+/** The fields of an item heading that give the optional fields of an item. */
+const ITEM_FIELDS = {
+	area: "area",
+	owner: "owner",
+	"waits for": "needs",
+	needs: "needs",
+	"depends on": "needs"
+};
+/**
+* This function gives the items of the second form of a roadmap: each heading "### `id`: Title" or
+* "### id · Title". The list item "Status:" gives the status. Without it, the "##" heading above
+* the item gives the status, for example "Waiting on Mark", "Later" or "Shipped". A heading without
+* a status is not an item.
+*
+* The list items "Area:", "Owner:" and "Waits for:" give the optional fields. The list item
+* "Links:" and the other list items give the links. Fenced code is not read.
+*/
+function headingItems(markdown, options) {
+	const lines = String(markdown).split(/\r?\n/);
+	const items = [];
+	let section = "";
+	let current;
+	let fence = null;
+	for (let index = 0; index < lines.length; index++) {
+		const line = lines[index] ?? "";
+		const fenceMark = /^\s*(`{3,}|~{3,})/.exec(line)?.[1];
+		if (fenceMark !== void 0) {
+			if (fence === null) fence = fenceMark[0] ?? null;
+			else if (fenceMark[0] === fence) fence = null;
+			continue;
+		}
+		if (fence !== null) continue;
+		const heading = /^(#{1,6})\s+(.*?)\s*#*\s*$/.exec(line);
+		if (heading) {
+			const level = heading[1]?.length ?? 0;
+			if (level > 3) continue;
+			current = void 0;
+			if (level === 2) section = plainText(heading[2]);
+			if (level === 1) section = "";
+			if (level !== 3) continue;
+			const item = ITEM_HEADING.exec(line) ?? ITEM_HEADING_DOT.exec(line);
+			const id = plainText(item?.[1]);
+			if (!item || isEmpty(id)) continue;
+			current = {
+				id,
+				title: item[2] ?? "",
+				status: section,
+				statusClass: statusClassOf(section),
+				section,
+				line: index + 1,
+				links: []
+			};
+			items.push(current);
+			continue;
+		}
+		if (!current) continue;
+		const field = ITEM_FIELD.exec(line);
+		const label = (field?.[2] ?? "").trim().toLowerCase();
+		const value = (field?.[3] ?? "").trim();
+		const key = field ? ITEM_FIELDS[label] : void 0;
+		if (field && label === "status") {
+			if (!isEmpty(value)) {
+				current.status = value;
+				current.statusClass = statusClassOf(plainText(value));
+			}
+		} else if (field && key !== void 0) {
+			if (!isEmpty(value)) current[key] = value;
+		} else if (/^\s*[-*]\s+/.test(line)) {
+			const seen = new Set(current.links.map((link) => link.url));
+			for (const link of linksOf(line, options)) if (!seen.has(link.url)) current.links.push(link);
+		}
+	}
+	return items.filter((item) => item.status !== "");
+}
+/**
+* This function gives the items of a roadmap file in the order of the file. It reads two forms:
+*
+* - Each row of each table with an `ID` column and a `Status` column. The header names match without
+*   case. The title comes from `Item`, else from `Title`. `Owner`, `Area` and `Needs` are optional.
+*   `Where`, `Commit` and `Links` give the links.
+* - Each heading "### `id`: Title" or "### id · Title". The list item "Status:", else the "##"
+*   heading above it, gives the status. The list items "Area:", "Owner:" and "Waits for:" give the
+*   optional fields, and "Links:" and the other list items give the links.
 *
-* @remarks The title comes from `Item`, else from `Title`. `Owner`, `Area` and `Needs` are optional.
-* `Where`, `Commit` and `Links` give the links.
 * @throws RoadmapParseError when the cells of a row do not match the header
 */
 function roadmapItems(markdown, options = {}) {
@@ -1081,7 +1170,11 @@ function roadmapItems(markdown, options = {}) {
 			items.push(item);
 		}
 	}
-	return items;
+	const headings = headingItems(markdown, {
+		...options,
+		file
+	});
+	return headings.length === 0 ? items : [...items, ...headings].sort((a, b) => a.line - b.line);
 }
 /** This function puts the roadmap items and the GitHub part into the shape of `status.json`. */
 function buildStatusBoard(input) {
@@ -1108,7 +1201,8 @@ function buildStatusBoard(input) {
 /**
 * This function reads the board of a repository on disk: the roadmap file, and the open work on GitHub.
 *
-* @throws RoadmapParseError when the roadmap has an incorrect row, or no table with an ID and a Status column
+* @throws RoadmapParseError when the roadmap has an incorrect row, or no item: no table with an ID
+* and a Status column, and no item heading
 */
 async function readStatusBoard(options) {
 	const { repoDir, roadmap = null, owner, repo, token, commit = null } = options;
@@ -1120,7 +1214,7 @@ async function readStatusBoard(options) {
 			repository,
 			ref: commit ?? "HEAD"
 		});
-		if (items.length === 0) throw new RoadmapParseError(`${roadmap}: no table with an ID column and a Status column`);
+		if (items.length === 0) throw new RoadmapParseError(`${roadmap}: no table with an ID column and a Status column, and no heading "### \`id\`: Title"`);
 	}
 	const github = await githubOpenWork({
 		owner,
@@ -2264,4 +2358,4 @@ async function runCli(argv, io) {
 //#endregion
 export { GITHUB_API as $, RoadmapParseError as A, DEFAULT_CHANGELOGS as B, longDate as C, inlineMarkdown as D, escapeHtml as E, plainText as F, globFiles as G, mergeReleases as H, readStatusBoard as I, headingDate as J, gitTagDates as K, roadmapItems as L, buildStatusBoard as M, linksOf as N, safeUrl as O, markdownTables as P, npmPublishTimes as Q, splitRow as R, dayRange as S, utcDay as T, readChangelogs as U, ReleaseDataError as V, readReleases as W, originRepository as X, isShallow as Y, NPM_REGISTRY as Z, oldestFirst as _, runCli as a, headingAnchor as at, BASE_CSS as b, openGroups as c, compareVersions as ct, slugOf as d, versionOfTag as dt, GITHUB_GRAPHQL as et, statusLead as f, laneCenter as g, renderReleasesPage as h, parseBuildArgs as i, firstSentence as it, STATUS_CLASSES as j, OPEN_CLASSES as k, renderStatusPage as l, kindOf as lt, releasesLead as m, UsageError as n, githubOpenWork as nt, STATUS_SCRIPT as o, parseChangelog as ot, RELEASES_SCRIPT as p, headCommit as q, build as r, githubReleases as rt, classCounts as s, releaseBodyEntries as st, HELP as t, checkStateOf as tt, sectionsOf as u, parseVersion as ut, releaseSummary as v, shortDate as w, pageShell as x, timelineLayout as y, statusClassOf as z };
 
-//# sourceMappingURL=build-vAps0mRE.js.map
+//# sourceMappingURL=build-CDw3NHWL.js.map