@mark1russell7/site-pages 0.2.12 → 0.2.14

package/README.md

@@ -166,7 +166,7 @@ Two fields of a stamp change the age rule:
 - `"study": true` marks a fixed study. The data has no age limit, and the rule 3 does not apply. The run names the method or the run, the date and the engine version. The stamp line tells in plain words that the page is a fixed study of that version. A page with a claim about the current engine is not a fixed study.
 - `"limit"` sets a longer age limit: `{ "days": 7, "reason": "The scan is weekly.", "workflow": ".github/workflows/scan.yml" }`. The stamp line shows the limit and the reason. The schedule of that workflow must meet the limit, or the gate fails. A limit with no schedule fails. A limit over 14 days (`MAX_LIMIT_DAYS_WITHOUT_RULING`) also needs a `ruling`, a public https link for that site.
 
-When npm does not answer, the gate prints the rule 3 under `Not run` and does not fail. A workflow turns the gate on with the input `data-stamps` of `reusable-pages.yml`. The gate then runs from the template commit, so it needs no install.
+When npm does not answer, the gate prints the rule 3 under `Not run` and does not fail. A workflow turns the gate on with the input `data-stamps` of `reusable-pages.yml`. A site with its own Pages workflow uses the action `data-stamps` of the template. The gate then runs from the template commit, so it needs no install.
 
 `renderDataStamp(stamp)` gives the line that the page shows with its data: the run, its date, its engine versions and the run in flight.
 
@@ -191,7 +191,7 @@ The command merges four sources by version:
 1. **The changelogs of Changesets.** Each `## 1.2.3` section of a `CHANGELOG.md` gives a version and its changes. Each change has its commit, the first sentence of its text, and the packages that list it.
 2. **The GitHub releases.** Each release gives a version (from its tag), a date and a link. When no changelog has the version, the list items of the release text are the changes.
 3. **The git tags.** The tags `1.2.3`, `v1.2.3` and `name@1.2.3` give the date of a version.
-4. **npm.** The publication time of each version of `--packages` is the last source of a date.
+4. **npm.** The publication time of each version of `--packages` is the last source of a date. Each stable version of the group, or of the only package, is also a release. So a publication with no changelog heading stays on the list. With `--group`, a version of another package that the group does not have is a release with the name of its package, for example `viewer@0.4.1`.
 
 The date of a version comes from the git tag, else from the GitHub release, else from npm. Else it comes from the commit that added the version heading to the changelog. A version without a date gets the date of the next version, and the command writes a warning.
 
@@ -342,6 +342,9 @@ The functions of the command are also in the package:
 | --- | --- |
 | `readReleases(options)` | The releases of a repository on disk, with GitHub and npm |
 | `mergeReleases(sources)` | The releases from sources that the caller reads |
+| `releaseReading(listed, sources, now)` | The versions that the changelog, the package or npm name and a list does not show, and the version in flight. Use it for a list that a site keeps itself |
+| `versionCommitTime(repoDir, file)` | The time of the commit that set the version of a `package.json`, for the version in flight |
+| `changelogVersions(markdown)` | The versions of the headings of a changelog |
 | `readStatusBoard(options)` | The status data of a repository on disk, with GitHub |
 | `githubReleases`, `githubOpenWork`, `npmPublishTimes` | The data of one source. After an error, each function gives `{ available: false, reason }`. It does not throw. |
 | `renderReleasesPage(releases, options)`, `renderStatusPage(data, options)` | The HTML of a page |
@@ -432,6 +435,8 @@ The theme `auto` removes `data-theme`, and the CSS of the site then obeys `prefe
 
 The file `kpi.json` at the root of a site holds the measures of the project, in the format `kpi/1`. A reader outside the site takes the numbers from this file.
 
+A count that the build reads from the source is true at the commit of the build. Use `commitTime()` from `@mark1russell7/site-pages/vite` for its `at`.
+
 ```ts
 import { defineConfig } from "vite";
 import { siteKpi } from "@mark1russell7/site-pages/vite";

package/build/chunks/build.js

@@ -1,4 +1,4 @@
-import { C as readKpi, D as headingDate, E as headCommit, F as versionOfTag, M as compareVersions, N as kindOf, O as isShallow, P as parseVersion, T as gitTagDates, _ as KPI_FILE, d as escapeHtml, f as inlineMarkdown, h as plural, j as npmPublishTimes, k as originRepository, m as listText, p as link, y as KpiError } from "./freshness.js";
+import { A as originRepository, C as readKpi, D as headCommit, E as gitTagDates, F as kindOf, I as parseVersion, L as versionOfTag, N as npmPublishTimes, O as headingDate, P as compareVersions, _ as KPI_FILE, d as escapeHtml, f as inlineMarkdown, h as plural, k as isShallow, m as listText, p as link, y as KpiError } from "./freshness.js";
 import { stripTypeScriptTypes } from "node:module";
 import { existsSync, mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from "node:fs";
 import { basename, dirname, isAbsolute, join, posix, resolve } from "node:path";
@@ -135,6 +135,10 @@ function releaseBodyEntries(body) {
 function headingAnchor(heading) {
 	return heading.toLowerCase().trim().replace(/[^\p{L}\p{N}\s_-]/gu, "").replace(/\s/g, "-");
 }
+/** This function gives the versions of the headings of a changelog, in the order of the file. Another heading is not a version. */
+function changelogVersions(markdown) {
+	return parseChangelog(markdown).map((section) => section.version);
+}
 // src/data/github.ts
 /** The GraphQL endpoint of GitHub. */
 const GITHUB_GRAPHQL = "https://api.github.com/graphql";
@@ -467,8 +471,10 @@ function stepKind(version, previous) {
 *   version of a package is the kind `first`.
 * - A version with a prerelease part is not a release. npm also keeps the placeholder
 *   `0.0.0-bootstrap.0` of a new package.
+* - With `label`, each version has the name of its package, also when the times name one package.
+* - With `keep`, the function gives only the versions that `keep` accepts. The kind still comes from each version of the package.
 */
-function npmReleases(times, group) {
+function npmReleases(times, group, options = {}) {
 	const stable = times.filter((time) => (!group || time.name === group) && parseVersion(time.version)?.prerelease.length === 0);
 	const byPackage = /* @__PURE__ */ new Map();
 	for (const time of stable) {
@@ -483,13 +489,14 @@ function npmReleases(times, group) {
 		shortNames.set(name, short);
 		shortCount.set(short, (shortCount.get(short) ?? 0) + 1);
 	}
-	const several = byPackage.size > 1;
+	const several = options.label ?? byPackage.size > 1;
 	const releases = [];
 	for (const [name, list] of byPackage) {
 		list.sort((a, b) => compareVersions(a.version, b.version));
 		const short = shortNames.get(name) ?? name;
 		const label = (shortCount.get(short) ?? 0) > 1 ? name : short;
 		list.forEach((time, index) => {
+			if (options.keep && !options.keep(time.version)) return;
 			releases.push({
 				version: several ? `${label}@${time.version}` : time.version,
 				date: time.date,
@@ -508,13 +515,34 @@ function npmReleases(times, group) {
 	}
 	return releases.sort((a, b) => Date.parse(b.date) - Date.parse(a.date) || a.version.localeCompare(b.version));
 }
+/** The npm package whose versions a release list shows: the group, or else the only package of the npm times. */
+function npmLine(times, group) {
+	if (group) return group;
+	const names = new Set(times.map((time) => time.name));
+	return names.size === 1 ? [...names][0] : void 0;
+}
+/**
+* This function adds the lines of their own to the list of a group. A package of the group can have a version that the
+* group does not have. The list names that version with its package, because a reader looks for the package by its name.
+*/
+function withOwnLines(list, times, group) {
+	if (!group) return list;
+	const versions = new Set(list.map((release) => release.version));
+	const own = npmReleases(times.filter((time) => time.name !== group), void 0, {
+		label: true,
+		keep: (version) => !versions.has(version)
+	});
+	return own.length === 0 ? list : [...list, ...own].sort((a, b) => Date.parse(b.date) - Date.parse(a.date));
+}
 /**
 * This function merges the release sources into one entry for each version, the newest first.
 *
 * - The versions: the changelog of `group`, or else each changelog version and each GitHub release.
+* - The versions also include each stable npm version of the group, or of the only npm package. A publication with no changelog heading is still a release.
 * - The date: the git tag, else the GitHub release, else npm, else the commit of the changelog heading.
 * - The changes: the changelog entries, else the list items of the GitHub release text.
 * - Without a changelog version and without a GitHub release, each npm version of each package is a release.
+* - With `group`, a version of another package that the group does not have is a release with the name of its package.
 *
 * @throws ReleaseDataError when `group` has no changelog and other changelogs exist
 */
@@ -545,8 +573,10 @@ function mergeReleases(sources) {
 		for (const { sections } of parsed) for (const section of sections) versions.add(section.version);
 		for (const [version, list] of githubByVersion) if (list.some((entry) => inGroup(entry.package))) versions.add(version);
 	}
+	if (versions.size === 0) return withOwnLines(npmReleases(sources.npm ?? [], group), sources.npm ?? [], group);
+	const line = npmLine(sources.npm ?? [], group);
+	for (const time of sources.npm ?? []) if (time.name === line && parseVersion(time.version)?.prerelease.length === 0) versions.add(time.version);
 	const ordered = [...versions].sort((a, b) => compareVersions(b, a));
-	if (ordered.length === 0) return npmReleases(sources.npm ?? [], group);
 	const changelogChanges = /* @__PURE__ */ new Map();
 	const changelogOf = /* @__PURE__ */ new Map();
 	const groupFirst = groupChangelog ? [groupChangelog, ...parsed.filter((entry) => entry !== groupChangelog)] : parsed;
@@ -595,12 +625,16 @@ function mergeReleases(sources) {
 		}
 	}
 	const oldest = ordered[ordered.length - 1];
-	return ordered.map((version) => {
+	return withOwnLines(ordered.map((version) => {
 		const github = githubByVersion.get(version) ?? [];
 		let changes = changelogChanges.get(version);
 		if (!changes) {
 			changes = /* @__PURE__ */ new Map();
 			for (const { release, package: packageName } of github) for (const entry of releaseBodyEntries(release.body)) addChange(changes, entry, packageName ?? (group || null));
+			if (changes.size === 0 && line !== void 0 && npmByVersion.get(version)?.some((time) => time.name === line)) addChange(changes, {
+				commit: null,
+				text: `Version ${version} of \`${line}\` on npm.`
+			}, line);
 		}
 		const links = [];
 		const githubRelease = github.find((entry) => entry.package === group) ?? github.find((entry) => entry.package === null) ?? github[0];
@@ -633,7 +667,42 @@ function mergeReleases(sources) {
 			changes: sortedChanges(changes),
 			links
 		};
-	});
+	}), sources.npm ?? [], group);
+}
+/** The time that a release can take. After this time, a version with no tag is a failed release. */
+const IN_FLIGHT_MS = 864e5;
+/**
+* This function reads a release list against its sources. An old list and a list with a missing middle version both give
+* a gap. A version in flight gives no gap, because its release has not ended. After 1 day it gives a gap, so a failed
+* release shows. The check covers one line of versions, so give the plain versions of one package. It does not read a
+* page: a page that does not show its list has no gap here.
+*
+* @param listed - The versions of the list.
+* @param sources - The sources that name the versions.
+* @param now - The time of the check, in milliseconds.
+*/
+function releaseReading(listed, sources, now = Date.now()) {
+	const { current, tags, versionAt } = sources;
+	const inFlight = current !== void 0 && tags !== void 0 && versionAt !== void 0 && !tags.includes(current) && now - Date.parse(versionAt) < IN_FLIGHT_MS ? current : void 0;
+	const shown = new Set(listed);
+	const gaps = /* @__PURE__ */ new Map();
+	const add = (version, source) => {
+		if (shown.has(version) || version === inFlight) return;
+		const gap = gaps.get(version) ?? {
+			version,
+			sources: []
+		};
+		gap.sources.push(source);
+		gaps.set(version, gap);
+	};
+	for (const version of sources.changelog ?? []) add(version, "changelog");
+	if (sources.current !== void 0) add(sources.current, "current");
+	for (const version of sources.npm ?? []) if (parseVersion(version)?.prerelease.length === 0) add(version, "npm");
+	const ordered = [...gaps.values()].sort((a, b) => compareVersions(b.version, a.version));
+	return inFlight === void 0 ? { gaps: ordered } : {
+		gaps: ordered,
+		inFlight
+	};
 }
 /** The default patterns of the changelog files: the first pattern that finds a file wins. */
 const DEFAULT_CHANGELOGS = ["packages/*/CHANGELOG.md", "CHANGELOG.md"];
@@ -2302,6 +2371,6 @@ async function runCli(argv, io) {
 		throw error;
 	}
 }
-export { parseChangelog as $, STATUS_CLASSES as A, DEFAULT_CHANGELOGS as B, pageShell as C, utcDay as D, shortDate as E, plainText as F, globFiles as G, mergeReleases as H, readStatusBoard as I, checkStateOf as J, GITHUB_API as K, roadmapItems as L, linksOf as M, markdownTables as N, OPEN_CLASSES as O, parseRoadmap as P, headingAnchor as Q, splitRow as R, BASE_CSS as S, longDate as T, readChangelogs as U, ReleaseDataError as V, readReleases as W, githubReleases as X, githubOpenWork as Y, firstSentence as Z, renderReleasesPage as _, runCli as a, releaseSummary as b, STATUS_SCRIPT as c, renderStatusPage as d, releaseBodyEntries as et, sectionsOf as f, releasesLead as g, RELEASES_SCRIPT as h, parseBuildArgs as i, buildStatusBoard as j, RoadmapParseError as k, classCounts as l, statusLead as m, UsageError as n, TYPESCRIPT_PROBE as o, slugOf as p, GITHUB_GRAPHQL as q, build as r, probeScript as s, HELP as t, openGroups as u, laneCenter as v, dayRange as w, timelineLayout as x, oldestFirst as y, statusClassOf as z };
+export { firstSentence as $, STATUS_CLASSES as A, DEFAULT_CHANGELOGS as B, pageShell as C, utcDay as D, shortDate as E, plainText as F, releaseReading as G, mergeReleases as H, readStatusBoard as I, GITHUB_GRAPHQL as J, globFiles as K, roadmapItems as L, linksOf as M, markdownTables as N, OPEN_CLASSES as O, parseRoadmap as P, changelogVersions as Q, splitRow as R, BASE_CSS as S, longDate as T, readChangelogs as U, ReleaseDataError as V, readReleases as W, githubOpenWork as X, checkStateOf as Y, githubReleases as Z, renderReleasesPage as _, runCli as a, releaseSummary as b, STATUS_SCRIPT as c, renderStatusPage as d, headingAnchor as et, sectionsOf as f, releasesLead as g, RELEASES_SCRIPT as h, parseBuildArgs as i, buildStatusBoard as j, RoadmapParseError as k, classCounts as l, statusLead as m, UsageError as n, releaseBodyEntries as nt, TYPESCRIPT_PROBE as o, slugOf as p, GITHUB_API as q, build as r, probeScript as s, HELP as t, parseChangelog as tt, openGroups as u, laneCenter as v, dayRange as w, timelineLayout as x, oldestFirst as y, statusClassOf as z };
 
 //# sourceMappingURL=build.js.map