@optique/man 0.10.7-dev.485 → 1.0.0-dev.1109

package/dist/man-Leuf7kOn.js

@@ -1,218 +0,0 @@
-import { escapeHyphens, formatMessageAsRoff } from "./roff-C_MiRXVS.js";
-
-//#region src/man.ts
-/**
-* Formats a date for use in man pages.
-*
-* @param date The date to format, or undefined.
-* @returns The formatted date string, or undefined.
-* @since 0.10.0
-*/
-function formatDateForMan(date) {
-	if (date === void 0) return void 0;
-	if (typeof date === "string") return date;
-	const months = [
-		"January",
-		"February",
-		"March",
-		"April",
-		"May",
-		"June",
-		"July",
-		"August",
-		"September",
-		"October",
-		"November",
-		"December"
-	];
-	return `${months[date.getMonth()]} ${date.getFullYear()}`;
-}
-function escapeThField(value) {
-	return value.replace(/\\/g, "\\\\").replace(/"/g, "\\\"");
-}
-/**
-* Formats a single {@link UsageTerm} as roff markup for the SYNOPSIS section.
-*
-* @param term The usage term to format.
-* @returns The roff-formatted string.
-* @since 0.10.0
-*/
-function formatUsageTermAsRoff(term) {
-	if ("hidden" in term && term.hidden) return "";
-	switch (term.type) {
-		case "argument": return `\\fI${term.metavar}\\fR`;
-		case "option": {
-			const names = term.names.map((name) => `\\fB${escapeHyphens(name)}\\fR`).join(" | ");
-			const metavarPart = term.metavar ? ` \\fI${term.metavar}\\fR` : "";
-			return `[${names}${metavarPart}]`;
-		}
-		case "command": return `\\fB${term.name}\\fR`;
-		case "optional": {
-			const inner = formatUsageAsRoff(term.terms);
-			return `[${inner}]`;
-		}
-		case "multiple": {
-			const inner = formatUsageAsRoff(term.terms);
-			if (term.min < 1) return `[${inner} ...]`;
-			return `${inner} ...`;
-		}
-		case "exclusive": {
-			const alternatives = term.terms.map((t) => formatUsageAsRoff(t)).join(" | ");
-			return `(${alternatives})`;
-		}
-		case "literal": return term.value;
-		case "passthrough": return "[...]";
-		default: {
-			const _exhaustive = term;
-			throw new TypeError(`Unknown usage term type: ${_exhaustive.type}.`);
-		}
-	}
-}
-/**
-* Formats a {@link Usage} array as roff markup.
-*
-* @param usage The usage terms to format.
-* @returns The roff-formatted string.
-*/
-function formatUsageAsRoff(usage) {
-	return usage.map(formatUsageTermAsRoff).filter((s) => s !== "").join(" ");
-}
-/**
-* Formats a {@link DocEntry}'s term for man page output.
-*
-* @param term The usage term from the entry.
-* @returns The roff-formatted term string.
-*/
-function formatDocEntryTerm(term) {
-	switch (term.type) {
-		case "option": {
-			const names = term.names.map((name) => `\\fB${escapeHyphens(name)}\\fR`).join(", ");
-			const metavarPart = term.metavar ? ` \\fI${term.metavar}\\fR` : "";
-			return `${names}${metavarPart}`;
-		}
-		case "command": return `\\fB${term.name}\\fR`;
-		case "argument": return `\\fI${term.metavar}\\fR`;
-		case "literal": return term.value;
-		default: return formatUsageTermAsRoff(term);
-	}
-}
-/**
-* Formats a {@link DocSection} as roff markup with .TP macros.
-*
-* @param section The section to format.
-* @returns The roff-formatted section content.
-*/
-function formatDocSectionEntries(section) {
-	const lines = [];
-	for (const entry of section.entries) {
-		lines.push(".TP");
-		lines.push(formatDocEntryTerm(entry.term));
-		if (entry.description) {
-			let desc = formatMessageAsRoff(entry.description);
-			if (entry.default) desc += ` [${formatMessageAsRoff(entry.default)}]`;
-			lines.push(desc);
-		} else if (entry.default) lines.push(`[${formatMessageAsRoff(entry.default)}]`);
-	}
-	return lines.join("\n");
-}
-/**
-* Formats a {@link DocPage} as a complete man page in roff format.
-*
-* This function generates a man page following the standard man(7) format,
-* including sections for NAME, SYNOPSIS, DESCRIPTION, OPTIONS, and more.
-*
-* @example
-* ```typescript
-* import { formatDocPageAsMan } from "@optique/man/man";
-* import type { DocPage } from "@optique/core/doc";
-*
-* const page: DocPage = {
-*   brief: message`A sample CLI application`,
-*   usage: [{ type: "argument", metavar: "FILE" }],
-*   sections: [],
-* };
-*
-* const manPage = formatDocPageAsMan(page, {
-*   name: "myapp",
-*   section: 1,
-*   version: "1.0.0",
-* });
-* ```
-*
-* @param page The documentation page to format.
-* @param options The man page options.
-* @returns The complete man page in roff format.
-* @since 0.10.0
-*/
-function formatDocPageAsMan(page, options) {
-	const lines = [];
-	const thParts = [escapeThField(options.name.toUpperCase()), options.section.toString()];
-	const hasDate = options.date != null;
-	const hasVersion = options.version != null;
-	const hasManual = options.manual != null;
-	if (hasDate) thParts.push(`"${escapeThField(formatDateForMan(options.date))}"`);
-	else if (hasVersion || hasManual) thParts.push("\"\"");
-	if (hasVersion) thParts.push(`"${escapeThField(`${options.name} ${options.version}`)}"`);
-	else if (hasManual) thParts.push("\"\"");
-	if (hasManual) thParts.push(`"${escapeThField(options.manual)}"`);
-	lines.push(`.TH ${thParts.join(" ")}`);
-	lines.push(".SH NAME");
-	if (page.brief) lines.push(`${options.name} \\- ${formatMessageAsRoff(page.brief)}`);
-	else lines.push(options.name);
-	if (page.usage) {
-		lines.push(".SH SYNOPSIS");
-		lines.push(`.B ${options.name}`);
-		const usageStr = formatUsageAsRoff(page.usage);
-		if (usageStr) lines.push(usageStr);
-	}
-	if (page.description) {
-		lines.push(".SH DESCRIPTION");
-		lines.push(formatMessageAsRoff(page.description));
-	}
-	for (const section of page.sections) {
-		if (section.entries.length === 0) continue;
-		const title = section.title?.toUpperCase() ?? "OPTIONS";
-		lines.push(`.SH ${title}`);
-		lines.push(formatDocSectionEntries(section));
-	}
-	if (options.environment && options.environment.entries.length > 0) {
-		lines.push(".SH ENVIRONMENT");
-		lines.push(formatDocSectionEntries(options.environment));
-	}
-	if (options.files && options.files.entries.length > 0) {
-		lines.push(".SH FILES");
-		lines.push(formatDocSectionEntries(options.files));
-	}
-	if (options.exitStatus && options.exitStatus.entries.length > 0) {
-		lines.push(".SH EXIT STATUS");
-		lines.push(formatDocSectionEntries(options.exitStatus));
-	}
-	if (options.examples) {
-		lines.push(".SH EXAMPLES");
-		lines.push(formatMessageAsRoff(options.examples));
-	}
-	if (options.bugs) {
-		lines.push(".SH BUGS");
-		lines.push(formatMessageAsRoff(options.bugs));
-	}
-	if (options.seeAlso && options.seeAlso.length > 0) {
-		lines.push(".SH SEE ALSO");
-		const refs = options.seeAlso.map((ref, i) => {
-			const suffix = i < options.seeAlso.length - 1 ? "," : "";
-			return `.BR ${ref.name} (${ref.section})${suffix}`;
-		});
-		lines.push(refs.join("\n"));
-	}
-	if (options.author) {
-		lines.push(".SH AUTHOR");
-		lines.push(formatMessageAsRoff(options.author));
-	}
-	if (page.footer) {
-		lines.push(".PP");
-		lines.push(formatMessageAsRoff(page.footer));
-	}
-	return lines.join("\n");
-}
-
-//#endregion
-export { formatDateForMan, formatDocPageAsMan, formatUsageTermAsRoff };