asljs-rq-cli 0.1.1 → 0.1.3

package/bin/rq-mcp.js

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-
-import { main }
-  from '../dist/mcp.js';
-
-main(
-  process.argv.slice(2),
-  { cwd: process.cwd(),
-    env: process.env,
-    stdout: process.stderr,
-    stderr: process.stderr },
-  process.stdin,
-  line => process.stdout.write(line))
-  .catch(
-    error => {
-      console.error(
-        error instanceof Error
-          ? error.message
-          : String(error));
-
-      process.exitCode = 1;
-    });

package/dist/mcp.d.ts

@@ -1,28 +0,0 @@
-import { type McpServerInfo, type McpTool } from 'asljs-mcp';
-import { Io } from 'asljs-rq';
-import { Server } from 'node:http';
-import { Readable } from 'node:stream';
-export declare const SERVER_NAME = "asljs-rq";
-/**
- * The tools of the MCP server: a tool per `rq` command, run as that command
- * line in `io.cwd`, or in its `workingDir`, with its output as the result.
- */
-export declare function createTools(io: Io, servers?: Server[]): McpTool[];
-/**
- * Serves the `rq` commands as MCP tools over a line-delimited JSON-RPC
- * stream, e.g. standard input and output. Resolves when the input ends,
- * and closes the servers `view` started.
- */
-export declare function runMcpServer(io: Io, input: Readable, write: (line: string) => void): Promise<void>;
-/**
- * The `rq-mcp` executable: serves the tools with a logger provider made
- * from `--loglevel`, `--logfile`, `--logformat` and the `RQ_LOG_`
- * variables, and disposes it once the input ends. Standard output carries the
- * protocol, so a log level without a log file other than stdout throws here,
- * before the first request is read.
- */
-export declare function main(args: string[], io: Io, input: Readable, write: (line: string) => void): Promise<void>;
-/**
- * The name and the version of the installed package.
- */
-export declare function serverInfo(): McpServerInfo;

package/dist/mcp.js

@@ -1,70 +0,0 @@
-import { createLoggerProvider, readLoggerOptions } from 'asljs-logging';
-import { commandTools, serveLines } from 'asljs-mcp';
-import { getLogger } from 'asljs-rq';
-import { createRequire } from 'node:module';
-import { createCli, runCli } from './cli.js';
-export const SERVER_NAME = 'asljs-rq';
-/**
- * The tools of the MCP server: a tool per `rq` command, run as that command
- * line in `io.cwd`, or in its `workingDir`, with its output as the result.
- */
-export function createTools(io, servers = []) {
-    return commandTools(createCli([], io).cli, async (args) => {
-        let stdout = '';
-        let stderr = '';
-        const exitCode = await runCli(args, { ...io,
-            stdout: { write: (text) => {
-                    stdout += text;
-                } },
-            stderr: { write: (text) => {
-                    stderr += text;
-                } } }, servers);
-        return { exitCode,
-            stdout,
-            stderr };
-    });
-}
-/**
- * Serves the `rq` commands as MCP tools over a line-delimited JSON-RPC
- * stream, e.g. standard input and output. Resolves when the input ends,
- * and closes the servers `view` started.
- */
-export async function runMcpServer(io, input, write) {
-    const servers = [];
-    try {
-        await serveLines(input, write, createTools(io, servers), serverInfo(), { logger: getLogger(io, 'rq.mcp') });
-    }
-    finally {
-        for (const server of servers) {
-            await new Promise((resolve) => {
-                server.close(resolve);
-                server.closeAllConnections();
-            });
-        }
-    }
-}
-/**
- * The `rq-mcp` executable: serves the tools with a logger provider made
- * from `--loglevel`, `--logfile`, `--logformat` and the `RQ_LOG_`
- * variables, and disposes it once the input ends. Standard output carries the
- * protocol, so a log level without a log file other than stdout throws here,
- * before the first request is read.
- */
-export async function main(args, io, input, write) {
-    const loggerProvider = createLoggerProvider('RQ_LOG_', readLoggerOptions(args), { allowStdout: false });
-    try {
-        await runMcpServer({ ...io,
-            loggerProvider }, input, write);
-    }
-    finally {
-        await loggerProvider.dispose();
-    }
-}
-/**
- * The name and the version of the installed package.
- */
-export function serverInfo() {
-    const { version } = createRequire(import.meta.url)('../package.json');
-    return { name: SERVER_NAME,
-        version };
-}

package/dist/view-script.d.ts

@@ -1,41 +0,0 @@
-/**
- * The part of the diagram the window shows, in diagram coordinates: the SVG's
- * `viewBox`.
- */
-export interface ViewBox {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-export interface Point {
-    x: number;
-    y: number;
-}
-/**
- * The view box zoomed by a wheel turn of `deltaY` around `point`, which stays
- * where it is on the screen: a turn down, a positive `deltaY`, zooms out.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export declare function zoomAt(box: ViewBox, point: Point, deltaY: number): ViewBox;
-/**
- * The view box moved so that `grabbed`, the diagram point where a drag
- * started, is under the pointer, now over `point`.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export declare function panTo(box: ViewBox, grabbed: Point, point: Point): ViewBox;
-/**
- * Whether pressing `button` on `target` starts a pan: the main button on
- * empty space, not on a node or a link, so that a click on a node still opens
- * its document.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export declare function startsPan(button: number, target: {
-    closest(selector: string): unknown;
-}): boolean;

package/dist/view-script.js

@@ -1,39 +0,0 @@
-/**
- * The view box zoomed by a wheel turn of `deltaY` around `point`, which stays
- * where it is on the screen: a turn down, a positive `deltaY`, zooms out.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export function zoomAt(box, point, deltaY) {
-    const factor = Math.exp(deltaY * 0.0015);
-    return { x: point.x - (point.x - box.x) * factor,
-        y: point.y - (point.y - box.y) * factor,
-        width: box.width * factor,
-        height: box.height * factor };
-}
-/**
- * The view box moved so that `grabbed`, the diagram point where a drag
- * started, is under the pointer, now over `point`.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export function panTo(box, grabbed, point) {
-    return { x: box.x - (point.x - grabbed.x),
-        y: box.y - (point.y - grabbed.y),
-        width: box.width,
-        height: box.height };
-}
-/**
- * Whether pressing `button` on `target` starts a pan: the main button on
- * empty space, not on a node or a link, so that a click on a node still opens
- * its document.
- *
- * Its source is sent to the browser as part of the index page, so it uses
- * nothing but its arguments.
- */
-export function startsPan(button, target) {
-    return button === 0
-        && !target.closest('.node, a');
-}

package/dist/view.d.ts

@@ -1,39 +0,0 @@
-import { type PostReply } from 'asljs-mdcli';
-import { Io } from 'asljs-rq';
-import { Server } from 'node:http';
-export { DEFAULT_PORT } from 'asljs-mdcli';
-export interface ViewOptions {
-    /**
-     * The requirement file or folder to view, relative to the working
-     * directory, or an id or `.md` name; the requirements folder when absent.
-     */
-    target?: string;
-    /**
-     * The port to listen on, exactly; 0 picks a free one. When absent, the
-     * first free port from `DEFAULT_PORT` on.
-     */
-    port?: number;
-    host?: string;
-}
-/**
- * The body of a rendered document: a requirement or test starts with its
- * full path, which a click copies; any other document is its text alone.
- */
-export declare function renderDocument(file: string): Promise<string>;
-/**
- * Saves what the editor of a requirement or test sends to the document at
- * the URL's path in `folder`: its title and its text, unless the document
- * changed since the editor opened it; the ids of the requirements folder in
- * the text become links. Then the document is post-processed, as after a
- * command.
- */
-export declare function saveDocument(io: Io, folder: string, url: URL, body: unknown): Promise<PostReply>;
-/**
- * Starts a web server for a requirement file or folder. It serves the
- * documents folder, or the folder of the graph when none is given, which must
- * contain the graph's folder. `/` shows the graph, whose nodes open the
- * documents; a `.md` file of the served folder is shown rendered and any other
- * file as it is, so a document a requirement links to opens wherever it is in
- * the folder. The graph is reloaded on every request for `/`.
- */
-export declare function execView(io: Io, options: ViewOptions): Promise<Server>;

package/dist/view.js

@@ -1,321 +0,0 @@
-import { escapeHtml, markdownToHtml, page, postProcess, serverUrl, startServer, takeWritten, writeMarkdown } from 'asljs-mdcli';
-import { findTarget, getLogger, getNodeKind, getRequirementsDir, getResults, getVersion, isFile, isInside, loadGraph, readEditable, readIds, readImplementation, renderImplementationTable, toMermaid, writeEdited } from 'asljs-rq';
-import { readFile } from 'node:fs/promises';
-import path from 'node:path';
-import { panTo, startsPan, zoomAt } from './view-script.js';
-export { DEFAULT_PORT } from 'asljs-mdcli';
-const MERMAID_MODULE = 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
-/**
- * The full path above a requirement or test, small and grey; a click copies
- * it.
- */
-const DOCUMENT_STYLE = `.rq-head { display: flex; align-items: baseline; justify-content: space-between; gap: 1rem; margin: 0 0 0.5rem; }
-.rq-path { margin: 0; font-family: ui-monospace, monospace; font-size: 0.8rem; color: #757575; cursor: copy; overflow-wrap: anywhere; }
-.rq-path.copied { color: #2e7d32; }
-.rq-title { display: flex; align-items: baseline; gap: 0.5rem; margin: 0.67em 0; font-size: 2em; font-weight: bold; }
-.rq-id { color: #757575; }
-#rq-title { flex: 1; min-width: 0; font: inherit; padding: 0 0.25rem; }
-#rq-editor { border: 1px solid #ddd; min-height: 300px; }
-.rq-note, #rq-message { color: #757575; font-size: 0.85rem; }
-.rq-implementation { border-collapse: collapse; }
-.rq-implementation th, .rq-implementation td { border-bottom: 1px solid #ddd; padding: 0.25rem 0.75rem 0.25rem 0; text-align: left; }
-.rq-pass { color: #2e7d32; }
-.rq-fail, .rq-missing { color: #c62828; }
-.rq-not-run { color: #757575; }`;
-/**
- * Stands for a requirement's Implementation list until the rest is rendered.
- */
-const TABLE_PLACEHOLDER = 'RQIMPLEMENTATIONTABLE';
-/**
- * The Milkdown editor, loaded when Edit is pressed: one module with its
- * dependencies, since separate modules can load ProseMirror twice, and its
- * theme.
- */
-const CREPE_MODULE = 'https://esm.sh/@milkdown/crepe@7.22.3?bundle';
-const CREPE_THEME = 'https://cdn.jsdelivr.net/npm/@milkdown/crepe@7.22.3/lib/theme';
-/**
- * Edit replaces the rendered document with a field for the title and a
- * Milkdown editor for the text, loaded only then; Save, or Ctrl+S, sends
- * both back with the version the page was made from, and reloads the page
- * once saved.
- */
-const EDIT_SCRIPT = `<script type="module">
-const data = JSON.parse(document.getElementById('rq-edit-data').textContent);
-const button = document.getElementById('rq-edit');
-const form = document.getElementById('rq-form');
-const title = document.getElementById('rq-title');
-const message = document.getElementById('rq-message');
-let crepe = null;
-button.addEventListener('click', async () => {
-  button.disabled = true;
-  button.textContent = 'Loading…';
-  for (const sheet of [ 'common', 'frame' ]) {
-    const link = document.createElement('link');
-    link.rel = 'stylesheet';
-    link.href = '${CREPE_THEME}/' + sheet + '/style.css';
-    document.head.append(link);
-  }
-  try {
-    const { Crepe } = await import('${CREPE_MODULE}');
-    crepe = new Crepe({ root: document.getElementById('rq-editor'), defaultValue: data.body });
-    await crepe.create();
-  } catch (error) {
-    button.disabled = false;
-    button.textContent = 'Edit';
-    message.textContent = 'The editor did not load: ' + error.message;
-    return;
-  }
-  document.getElementById('rq-view').hidden = true;
-  button.hidden = true;
-  form.hidden = false;
-  title.value = data.title;
-  title.focus();
-});
-form.addEventListener('submit', async (event) => {
-  event.preventDefault();
-  message.textContent = 'Saving…';
-  const response = await fetch(location.pathname, {
-    method: 'POST',
-    headers: { 'content-type': 'application/json' },
-    body: JSON.stringify({ version: data.version, title: title.value, body: crepe.getMarkdown() })
-  });
-  const reply = await response.json().catch(() => ({ error: response.statusText }));
-  if (response.ok) {
-    location.reload();
-  } else {
-    message.textContent = reply.error;
-  }
-});
-document.addEventListener('keydown', (event) => {
-  if (!form.hidden && (event.ctrlKey || event.metaKey) && event.key === 's') {
-    event.preventDefault();
-    form.requestSubmit();
-  }
-});
-document.getElementById('rq-cancel').addEventListener('click', () => location.reload());
-</script>`;
-/**
- * Copies the path a `.rq-path` holds when it is clicked, and shows it was
- * copied for a moment.
- */
-const COPY_SCRIPT = `<script>
-document.querySelector('.rq-path').addEventListener('click', async (event) => {
-  const element = event.currentTarget;
-  await navigator.clipboard.writeText(element.dataset.path);
-  element.classList.add('copied');
-  setTimeout(() => element.classList.remove('copied'), 1000);
-});
-</script>`;
-/**
- * The body of a rendered document: a requirement or test starts with its
- * full path, which a click copies; any other document is its text alone.
- */
-export async function renderDocument(file) {
-    const text = await readFile(file, 'utf8');
-    const kind = getNodeKind(file);
-    if (kind === null) {
-        return markdownToHtml(text);
-    }
-    // A requirement's Implementation list is shown as a table of what it
-    // links to, with their coverage and result.
-    const implementation = kind === 'requirement'
-        ? await readImplementation(file, text, TABLE_PLACEHOLDER)
-        : null;
-    const html = implementation === null
-        ? markdownToHtml(text)
-        : markdownToHtml(implementation.text)
-            .replace(`<p>${TABLE_PLACEHOLDER}</p>`, renderImplementationTable(implementation.rows));
-    const editable = readEditable(file, text);
-    // The editor's data, safe inside a script element.
-    const data = JSON.stringify(editable)
-        .replace(/</g, '\\u003c');
-    return `<div class="rq-head">
-<p class="rq-path" data-path="${escapeHtml(file)}" title="Copy the path">${escapeHtml(file)}</p>
-<p><span id="rq-message"></span> <button type="button" id="rq-edit">Edit</button></p>
-</div>
-<div id="rq-view">
-${html}
-</div>
-<form id="rq-form" hidden>
-<p class="rq-title"><span class="rq-id">${escapeHtml(editable.id)}</span><input id="rq-title" aria-label="Title"></p>
-<div id="rq-editor"></div>
-<p class="rq-note">Implementation, Coverage and Status are kept as they are, after the text. Ids such as R2 or T3 become links when saved.</p>
-<p><button type="submit">Save</button> <button type="button" id="rq-cancel">Cancel</button></p>
-</form>
-<script type="application/json" id="rq-edit-data">${data}</script>
-${COPY_SCRIPT}
-${EDIT_SCRIPT}`;
-}
-/**
- * Saves what the editor of a requirement or test sends to the document at
- * the URL's path in `folder`: its title and its text, unless the document
- * changed since the editor opened it; the ids of the requirements folder in
- * the text become links. Then the document is post-processed, as after a
- * command.
- */
-export async function saveDocument(io, folder, url, body) {
-    const pathname = decodeURIComponent(url.pathname);
-    const file = path.resolve(folder, `.${pathname}`);
-    if (!isInside(folder, file)
-        || getNodeKind(file)
-            === null
-        || !await isFile(file)) {
-        return { status: 404,
-            body: { error: `No requirement or test at ${pathname}.` } };
-    }
-    if (!isEdit(body)) {
-        return { status: 400,
-            body: { error: 'Send the version, the title and the text.' } };
-    }
-    const text = await readFile(file, 'utf8');
-    if (getVersion(text)
-        !== body.version) {
-        return { status: 409,
-            body: { error: 'The document changed since the editor opened it; copy your text, reload the page and edit again.' } };
-    }
-    await writeMarkdown(file, writeEdited(file, text, body, await readIds(getRequirementsDir(io))));
-    const processed = await postProcess({ ...io,
-        logger: getLogger(io, 'rq.post-process') }, takeWritten(), 'rq.json');
-    return { status: 200,
-        body: processed === 0
-            ? { saved: true }
-            : { saved: true,
-                warning: 'markdownPostProcessing failed; see the server output.' } };
-}
-function isEdit(body) {
-    return typeof body === 'object'
-        && body !== null
-        && typeof body.version === 'string'
-        && typeof body.title === 'string'
-        && typeof body.body === 'string';
-}
-/**
- * The index is the diagram alone, filling the window.
- */
-const INDEX_STYLE = `html, body { height: 100%; }
-body { max-width: none; margin: 0; padding: 0; overflow: hidden; }
-#diagram { position: fixed; inset: 0; cursor: grab; touch-action: none; user-select: none; -webkit-user-select: none; }
-#diagram.panning { cursor: grabbing; }
-#diagram > pre.mermaid { margin: 0; width: 100%; height: 100%; }
-#diagram svg { display: block; width: 100%; height: 100%; max-width: none !important; }
-#diagram .node { cursor: pointer; }
-#problems { position: fixed; top: 0.5rem; right: 0.5rem; max-width: 40%; max-height: 40%; overflow: auto; background: #fff8e1; border: 1px solid #ef8f00; padding: 0 0.75rem; font-size: 0.875rem; }
-#problems h2 { font-size: 1rem; }`;
-/**
- * Draws the diagram, then zooms it with the mouse wheel around the pointer and
- * pans it by dragging empty space. A click on a node opens its document, through
- * the `click` links of the diagram. The geometry is `zoomAt`, `panTo` and
- * `startsPan`, sent as their own source.
- */
-const SCRIPT = `import mermaid from '${MERMAID_MODULE}';
-${zoomAt.toString()}
-${panTo.toString()}
-${startsPan.toString()}
-mermaid.initialize({ startOnLoad: false, securityLevel: 'loose' });
-await mermaid.run({ querySelector: '#diagram .mermaid' });
-const box = document.getElementById('diagram');
-const svg = box.querySelector('svg');
-svg.removeAttribute('width');
-svg.removeAttribute('height');
-const { x, y, width, height } = svg.viewBox.baseVal;
-let view = { x, y, width, height };
-const show = () =>
-  svg.setAttribute('viewBox', \`\${view.x} \${view.y} \${view.width} \${view.height}\`);
-const toDiagram = (event) =>
-  new DOMPoint(event.clientX, event.clientY).matrixTransform(svg.getScreenCTM().inverse());
-box.addEventListener('wheel', (event) => {
-  event.preventDefault();
-  view = zoomAt(view, toDiagram(event), event.deltaY);
-  show();
-}, { passive: false });
-let drag = null;
-box.addEventListener('pointerdown', (event) => {
-  if (!startsPan(event.button, event.target)) {
-    return;
-  }
-  // Without this, the browser starts selecting the diagram's text.
-  event.preventDefault();
-  drag = { pointer: event.pointerId, grabbed: toDiagram(event) };
-  box.setPointerCapture(event.pointerId);
-  box.classList.add('panning');
-});
-box.addEventListener('pointermove', (event) => {
-  if (drag?.pointer !== event.pointerId) {
-    return;
-  }
-  view = panTo(view, drag.grabbed, toDiagram(event));
-  show();
-});
-const stop = (event) => {
-  if (drag?.pointer === event.pointerId) {
-    drag = null;
-    box.classList.remove('panning');
-  }
-};
-box.addEventListener('pointerup', stop);
-box.addEventListener('pointercancel', stop);`;
-/**
- * Starts a web server for a requirement file or folder. It serves the
- * documents folder, or the folder of the graph when none is given, which must
- * contain the graph's folder. `/` shows the graph, whose nodes open the
- * documents; a `.md` file of the served folder is shown rendered and any other
- * file as it is, so a document a requirement links to opens wherever it is in
- * the folder. The graph is reloaded on every request for `/`.
- */
-export async function execView(io, options) {
-    const target = await findTarget(io, options.target);
-    const graphFolder = (await loadGraph(target)).folder;
-    const folder = io.documentsDir ?? graphFolder;
-    if (!isInside(folder, graphFolder)) {
-        throw new Error(`${graphFolder} is not inside the documents folder ${folder}.`);
-    }
-    const server = await startServer({ folder,
-        index: async () => {
-            const graph = await loadGraph(target);
-            return renderIndex(folder, graph, getResults(graph));
-        },
-        home: 'Requirements',
-        style: DOCUMENT_STYLE,
-        render: renderDocument,
-        post: async (url, body) => saveDocument(io, folder, url, body),
-        port: options.port,
-        host: options.host,
-        logger: getLogger(io, 'rq.view') });
-    io.stdout.write(`Serving ${folder === graphFolder
-        ? folder
-        : `${graphFolder} in ${folder}`} at ${serverUrl(server)}\n`);
-    return server;
-}
-function renderIndex(folder, graph, results) {
-    const href = (file) => {
-        if (!isInside(folder, file)) {
-            return null;
-        }
-        return `/${encodeURI(path.relative(folder, file)
-            .split(path.sep)
-            .join('/'))}`;
-    };
-    const title = (graph.roots.length === 1
-        ? graph.nodes.get(graph.roots[0])?.title
-        : null)
-        ?? 'Requirements';
-    const problems = graph.errors.length === 0
-        ? ''
-        : `<aside id="problems">
-<h2>Problems</h2>
-<ul>
-${graph.errors
-            .map(error => `<li>${escapeHtml(error)}</li>`)
-            .join('\n')}
-</ul>
-</aside>
-`;
-    return page(title, `<main id="diagram">
-<pre class="mermaid">
-${escapeHtml(toMermaid(graph, href, results))}
-</pre>
-</main>
-${problems}<script type="module">
-${SCRIPT}
-</script>`, INDEX_STYLE);
-}

package/docs/rq view.md

@@ -1,101 +0,0 @@
-# rq view
-
-Starts a web server for a requirement file or folder, and runs until stopped, by
-SIGINT (Ctrl+C) or SIGTERM.
-
-```text
-rq view [path] [--port <port>] [--working-dir <folder>]
-        [--requirements-dir <folder>] [--documents-dir <folder>]
-```
-
-`[path]` is a requirement file, a folder, a `.md` name or an id; the
-requirements folder by default. The index shows its graph.
-
-The server serves the documents folder; see
-[Requirements and documents folders][FD]. When none is set, it serves the folder
-of the graph: `[path]` when it is a folder, the file's folder otherwise. The
-graph's folder must be inside the served folder; `rq view` reports an error
-otherwise. It listens on `127.0.0.1`.
-
-```text
-rq view requirements --documents-dir .
-```
-
-serves the whole project, so a requirement's link to `docs/design.md` opens
-rendered, and the index still shows the graph of `requirements`.
-
-- `/` - the index: the graph as a left-to-right Mermaid diagram of the
-  requirements and tests and their `## Implementation` links, filling the
-  window, and nothing else; the structure errors, when there are any, are listed
-  in a box over its corner. Other documents are not drawn. Each node's border
-  shows its state, from its `## Status` section:
-  - colour, from `Result`, or for a requirement that records none the result
-    that follows from its links - neutral grey for `NOT RUN`, green for `PASS`,
-    red for a test that is `FAIL`, amber for a requirement that is `FAIL`
-    because of what it links to;
-  - style, from `Coverage`, which `rq coverage` writes - solid for a test and
-    for a requirement that is `COMPLETE`, dashed for one that is `INCOMPLETE`,
-    dotted for one without `Coverage`.
-
-  The mouse wheel zooms in and out around the pointer, and dragging empty space
-  pans. Clicking a node opens its document, at its path in the served folder,
-  e.g. `/requirements/R1 Export.md`. All roots are in the one diagram; the page
-  is titled with the root's heading when there is one root, `Requirements`
-  otherwise. The graph is read again on every request, so a reload shows the
-  current files.
-- `/<file>.md` - the document rendered as HTML. Its links to other `.md` files
-  open them rendered. A requirement or test starts with its full path, small and
-  grey; a click copies it to the clipboard. A requirement's `## Implementation`
-  list is shown as a table of what it links to: each one's id and title, linking
-  to it, the `Coverage` its `## Status` records, as Complete or Partial, and its
-  `Result`, `NOT RUN` when it records none; an item whose document is missing
-  says so.
-- any other file of the served folder is served as it is, e.g. an image a
-  document shows.
-
-The server is for local use: it serves every file inside the served folder,
-including hidden ones, and renders the documents' HTML as it is. It takes a save
-only as JSON, sent to `localhost` or its address from its own pages, so another
-site cannot write through it.
-
-Nodes outside the served folder are drawn but do not open. The diagram is drawn
-by Mermaid, loaded from `cdn.jsdelivr.net`; without it the index shows the
-diagram's Mermaid text.
-
-## Editing
-
-A requirement or test has an Edit button next to its path. It opens:
-
-- the title, in a field after the id, which stays as it is; the file keeps its
-  name, which [`rq move`][MV] changes;
-- the rest of the text in a [Milkdown][MK] editor, without `## Implementation`,
-  `## Coverage` and `## Status`, which the commands own. A link to a requirement
-  or test by its id shows as the id alone, e.g. `R2`, and any other reference
-  link as an inline link.
-
-Save, or Ctrl+S, writes the heading, the id and the title, then the text, then
-the definitions the owned sections use and the owned sections as they were. Each
-id of a requirement or test of the requirements folder in the text, outside
-code, becomes a reference link to it again, e.g. `[R2][]`, with its definition
-after the text. The document is then post-processed with
-`markdownPostProcessing` of `rq.json`, as after a command. A save is refused
-when the file changed since the editor opened it: reload the page and edit
-again. Cancel reloads the page. Milkdown is loaded from `esm.sh`, and its theme
-from `cdn.jsdelivr.net`, when Edit is pressed.
-
-## Options
-
-- `--port <port>` - the port, exactly: one in use is an error, and 0 picks any
-  free one. Without it, the first free port from 3000 on, up to 3099. The
-  address is printed when the server starts.
-- `--working-dir <folder>` - the working folder, whose `.rq` folder holds the
-  results; see [Working folder][WF]. The results are read again on every request
-  for `/`.
-- `--requirements-dir <folder>`, `--documents-dir <folder>` - the requirements
-  folder, the default `[path]`, and the documents folder, the served one; see
-  [Requirements and documents folders][FD].
-
-[FD]: ../../../libs/rq/docs/Requirements.md#requirements-and-documents-folders
-[WF]: ../../../libs/rq/docs/Requirements.md#working-folder
-[MK]: https://milkdown.dev
-[MV]: <Changing the graph.md#rq-move>