@wpelevator/wp-release 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -1,17 +1,19 @@
 export { run, execute, commands, getHelp, getCommandHelp } from './cli.ts';
+export { logError, logProblems } from './report.ts';
 export { getDeployInputFromArgs } from './commands/deploy-svn.ts';
 export { ValidationError, CredentialsError } from './errors.ts';
-export { Logger } from './logger.ts';
+export { Logger, TextWriter } from './logger.ts';
+export { GitHubActionsWriter } from './github-actions-writer.ts';
 export { SVN_URL, isPrerelease, normalizeTag, isTagRef, isValidSlug, isValidVersion, getDeployOptionErrors, getDeployOptionWarnings, resolveDeployOptions, } from './deploy-options.ts';
 export { DISTIGNORE_FILENAME, parseExclude, resolveFileSelection, loadFileRules, selectFiles, } from './file-selection.ts';
 export { FILENAME_FORMAT, formatFilename } from './filename.ts';
 export { CHECKSUMS_EXTENSION, CHECKSUM_ALGORITHMS, hashFile, hashFiles, createChecksums, writeChecksums, readChecksums, parseChecksums, compareChecksums, verifyChecksums, } from './checksums.ts';
-export { HEADER_BYTES, PLUGIN_HEADERS, THEME_HEADERS, README_HEADERS, README_FILENAMES, parseFileHeaders, parseReadmeHeaders, readFileStart, findMainPluginFile, readPackageMeta, } from './package-meta.ts';
+export { HEADER_BYTES, PLUGIN_HEADERS, THEME_HEADERS, README_HEADERS, README_FILENAMES, parseFileHeaders, parseReadmeHeaders, readFileStart, findFileHeaderLine, findReadmeHeaderLine, findMainPluginFile, readPackageMeta, } from './package-meta.ts';
 export { SIGNATURE_EXTENSION, SIGNING_KEY_ENV, parseSigningKey, parsePublicKey, getPublicKey, getFileDigest, signFile, writeSignature, verifyFileSignature, } from './signing.ts';
 export { ZIP_MTIME, ZIP_FILE_MODE, createZip } from './zip.ts';
 export { isUrl, downloadFile } from './download.ts';
 export { readZipEntries, getZipEntryErrors, extractZip } from './unzip.ts';
-export { GIT_TAG_FORMAT, getGitTagVersion, findConstantValues, findVersionMismatches, } from './version-check.ts';
+export { GIT_TAG_FORMAT, VersionMismatchError, getGitTagVersion, findConstantValues, findConstantDefinitions, findVersionMismatches, getVersionMismatchProblems, } from './version-check.ts';
 export { Svn, SvnError, createSvnRunner, parseStatus, toSvnPath, } from './svn.ts';
 export { syncDirectory, copyFileIfChanged } from './sync.ts';
 export { ASSET_MIME_TYPES, SvnDeploy } from './svn-deploy.ts';
@@ -21,7 +23,9 @@ export type { SignResult } from './commands/sign.ts';
 export type { ZipResult } from './commands/zip.ts';
 export type { Command, CommandContext, CommandOutcome, ParsedValues, } from './commands/command.ts';
 export type { DeployArgsInput } from './commands/deploy-svn.ts';
-export type { LoggerOptions, OutputStream } from './logger.ts';
+export type { Annotation, LogEntry, LogLevel, LogWriter, LoggerOptions, OutputStream, SummaryBuilder, TextWriterOptions, } from './logger.ts';
+export type { GitHubActionsWriterOptions } from './github-actions-writer.ts';
+export type { Problem } from './errors.ts';
 export type { DeployInput, DeployOptions } from './deploy-options.ts';
 export type { FileRules, FileSelection, FileSelectionInput, } from './file-selection.ts';
 export type { FilenameValues } from './filename.ts';
@@ -32,4 +36,5 @@ export type { ExtractZipInput, ZipEntryInfo, ZipEntryType } from './unzip.ts';
 export type { FindVersionMismatchesInput, GitTagInput, VersionCheckResult, VersionMismatch, } from './version-check.ts';
 export type { SvnCheckoutInput, SvnCommandInput, SvnCommandOutput, SvnCommitInput, SvnCopyInput, SvnDepth, SvnOptions, SvnPathsInput, SvnPropsetInput, SvnRunner, SvnStatusEntry, SvnStatusType, SvnUpdateInput, } from './svn.ts';
 export type { SyncDirectoryInput, SyncResult } from './sync.ts';
+export type { SummaryContext } from './summary.ts';
 export type { CheckoutPath, DeployResult } from './svn-deploy.ts';

package/dist/index.js

@@ -1,17 +1,19 @@
 export { run, execute, commands, getHelp, getCommandHelp } from "./cli.js";
+export { logError, logProblems } from "./report.js";
 export { getDeployInputFromArgs } from "./commands/deploy-svn.js";
 export { ValidationError, CredentialsError } from "./errors.js";
-export { Logger } from "./logger.js";
+export { Logger, TextWriter } from "./logger.js";
+export { GitHubActionsWriter } from "./github-actions-writer.js";
 export { SVN_URL, isPrerelease, normalizeTag, isTagRef, isValidSlug, isValidVersion, getDeployOptionErrors, getDeployOptionWarnings, resolveDeployOptions, } from "./deploy-options.js";
 export { DISTIGNORE_FILENAME, parseExclude, resolveFileSelection, loadFileRules, selectFiles, } from "./file-selection.js";
 export { FILENAME_FORMAT, formatFilename } from "./filename.js";
 export { CHECKSUMS_EXTENSION, CHECKSUM_ALGORITHMS, hashFile, hashFiles, createChecksums, writeChecksums, readChecksums, parseChecksums, compareChecksums, verifyChecksums, } from "./checksums.js";
-export { HEADER_BYTES, PLUGIN_HEADERS, THEME_HEADERS, README_HEADERS, README_FILENAMES, parseFileHeaders, parseReadmeHeaders, readFileStart, findMainPluginFile, readPackageMeta, } from "./package-meta.js";
+export { HEADER_BYTES, PLUGIN_HEADERS, THEME_HEADERS, README_HEADERS, README_FILENAMES, parseFileHeaders, parseReadmeHeaders, readFileStart, findFileHeaderLine, findReadmeHeaderLine, findMainPluginFile, readPackageMeta, } from "./package-meta.js";
 export { SIGNATURE_EXTENSION, SIGNING_KEY_ENV, parseSigningKey, parsePublicKey, getPublicKey, getFileDigest, signFile, writeSignature, verifyFileSignature, } from "./signing.js";
 export { ZIP_MTIME, ZIP_FILE_MODE, createZip } from "./zip.js";
 export { isUrl, downloadFile } from "./download.js";
 export { readZipEntries, getZipEntryErrors, extractZip } from "./unzip.js";
-export { GIT_TAG_FORMAT, getGitTagVersion, findConstantValues, findVersionMismatches, } from "./version-check.js";
+export { GIT_TAG_FORMAT, VersionMismatchError, getGitTagVersion, findConstantValues, findConstantDefinitions, findVersionMismatches, getVersionMismatchProblems, } from "./version-check.js";
 export { Svn, SvnError, createSvnRunner, parseStatus, toSvnPath, } from "./svn.js";
 export { syncDirectory, copyFileIfChanged } from "./sync.js";
 export { ASSET_MIME_TYPES, SvnDeploy } from "./svn-deploy.js";

package/dist/logger.d.ts

@@ -1,36 +1,108 @@
+import type { SummaryContext } from './summary.ts';
 /**
  * Stream that output is written to, like process.stdout.
  */
 export interface OutputStream {
     write: (text: string) => unknown;
 }
-export interface LoggerOptions {
-    /** Use GitHub Actions workflow commands. */
-    ci?: boolean;
-    /** Print errors only. */
-    quiet?: boolean;
-    /** Print debug messages. */
-    verbose?: boolean;
+/**
+ * Log levels, from the most to the least verbose.
+ */
+export type LogLevel = 'debug' | 'info' | 'notice' | 'warning' | 'error';
+/**
+ * File and title that a message is about, which writers like the GitHub
+ * Actions writer show as an annotation on the file.
+ */
+export interface Annotation {
+    /** File the message is about, absolute or relative to the working directory. */
+    file?: string | null;
+    /** Line in the file, starting at 1. */
+    line?: number | null;
+    /** Annotation title. */
+    title?: string;
+}
+/**
+ * A message passed from the logger to its writer.
+ */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    annotation: Annotation;
+}
+/**
+ * Builds the Markdown of a summary for the context of a writer.
+ */
+export type SummaryBuilder = (context: SummaryContext) => string;
+/**
+ * Destination of the log, like a terminal or a CI system. The logger decides
+ * which messages to write, and the writer decides how they look.
+ */
+export interface LogWriter {
+    /** Write a message. */
+    write: (entry: LogEntry) => void;
+    /** Start a collapsible group of messages. */
+    startGroup: (title: string) => void;
+    /** End the group started last. */
+    endGroup: () => void;
+    /** Add to the summary of the run, for writers that have one. */
+    summary: (build: SummaryBuilder) => void;
+}
+export interface TextWriterOptions {
     /** Stream for regular output. */
     stdout?: OutputStream;
     /** Stream for warnings and errors. */
     stderr?: OutputStream;
 }
 /**
- * Logger that prints plain text locally and GitHub Actions workflow commands in CI.
+ * Writer that prints plain text, for terminals and CI systems without
+ * special log formats.
+ */
+export declare class TextWriter implements LogWriter {
+    readonly stdout: OutputStream;
+    readonly stderr: OutputStream;
+    constructor({ stdout, stderr, }?: TextWriterOptions);
+    write({ level, message }: LogEntry): void;
+    startGroup(title: string): void;
+    endGroup(): void;
+    summary(): void;
+}
+export interface LoggerOptions {
+    /** Writer for the messages, a TextWriter by default. */
+    writer?: LogWriter;
+    /** Print errors and warnings only. */
+    quiet?: boolean;
+    /** Print debug messages. */
+    verbose?: boolean;
+}
+/**
+ * Logger that filters messages by level and passes them to a writer, which
+ * formats them for a terminal or a CI system.
  */
 export declare class Logger {
-    readonly ci: boolean;
+    readonly writer: LogWriter;
     readonly quiet: boolean;
     readonly verbose: boolean;
-    readonly stdout: OutputStream;
-    readonly stderr: OutputStream;
-    constructor({ ci, quiet, verbose, stdout, stderr, }?: LoggerOptions);
-    info(message: string): void;
+    constructor({ writer, quiet, verbose, }?: LoggerOptions);
+    /**
+     * Write a message unless its level is filtered out.
+     *
+     * @param level      Log level.
+     * @param message    Message.
+     * @param annotation File, line and title the message is about.
+     */
+    log(level: LogLevel, message: string, annotation?: Annotation): void;
     debug(message: string): void;
-    notice(message: string): void;
-    warning(message: string): void;
-    error(message: string): void;
+    info(message: string): void;
+    notice(message: string, annotation?: Annotation): void;
+    warning(message: string, annotation?: Annotation): void;
+    error(message: string, annotation?: Annotation): void;
+    /**
+     * Add to the summary of the run. Only writers with a summary, like the
+     * GitHub Actions job summary, call the builder.
+     *
+     * @param build Builds the summary Markdown.
+     */
+    summary(build: SummaryBuilder): void;
     /**
      * Run a callback inside a collapsible log group.
      *

package/dist/logger.js

@@ -1,39 +1,85 @@
 /**
- * Logger that prints plain text locally and GitHub Actions workflow commands in CI.
+ * Writer that prints plain text, for terminals and CI systems without
+ * special log formats.
+ */
+export class TextWriter {
+    stdout;
+    stderr;
+    constructor({ stdout = process.stdout, stderr = process.stderr, } = {}) {
+        this.stdout = stdout;
+        this.stderr = stderr;
+    }
+    write({ level, message }) {
+        const prefixes = {
+            warning: 'Warning: ',
+            error: 'Error: ',
+        };
+        const stream = 'warning' === level || 'error' === level
+            ? this.stderr
+            : this.stdout;
+        stream.write(`${prefixes[level] ?? ''}${message}\n`);
+    }
+    startGroup(title) {
+        this.stdout.write(`== ${title}\n`);
+    }
+    endGroup() { }
+    summary() { }
+}
+/**
+ * Logger that filters messages by level and passes them to a writer, which
+ * formats them for a terminal or a CI system.
  */
 export class Logger {
-    ci;
+    writer;
     quiet;
     verbose;
-    stdout;
-    stderr;
-    constructor({ ci = 'true' === process.env.GITHUB_ACTIONS, quiet = false, verbose = false, stdout = process.stdout, stderr = process.stderr, } = {}) {
-        this.ci = ci;
+    constructor({ writer = new TextWriter(), quiet = false, verbose = false, } = {}) {
+        this.writer = writer;
         this.quiet = quiet;
         this.verbose = verbose;
-        this.stdout = stdout;
-        this.stderr = stderr;
     }
-    info(message) {
-        if (!this.quiet) {
-            this.stdout.write(`${message}\n`);
+    /**
+     * Write a message unless its level is filtered out.
+     *
+     * @param level      Log level.
+     * @param message    Message.
+     * @param annotation File, line and title the message is about.
+     */
+    log(level, message, annotation = {}) {
+        const shown = {
+            debug: this.verbose && !this.quiet,
+            info: !this.quiet,
+            notice: !this.quiet,
+            warning: true,
+            error: true,
+        }[level];
+        if (shown) {
+            this.writer.write({ level, message, annotation });
         }
     }
     debug(message) {
-        if (this.verbose && !this.quiet) {
-            this.stdout.write(this.ci ? `::debug::${message}\n` : `${message}\n`);
-        }
+        this.log('debug', message);
     }
-    notice(message) {
-        if (!this.quiet) {
-            this.stdout.write(this.ci ? `::notice::${message}\n` : `${message}\n`);
-        }
+    info(message) {
+        this.log('info', message);
     }
-    warning(message) {
-        this.stderr.write(this.ci ? `::warning::${message}\n` : `Warning: ${message}\n`);
+    notice(message, annotation = {}) {
+        this.log('notice', message, annotation);
     }
-    error(message) {
-        this.stderr.write(this.ci ? `::error::${message}\n` : `Error: ${message}\n`);
+    warning(message, annotation = {}) {
+        this.log('warning', message, annotation);
+    }
+    error(message, annotation = {}) {
+        this.log('error', message, annotation);
+    }
+    /**
+     * Add to the summary of the run. Only writers with a summary, like the
+     * GitHub Actions job summary, call the builder.
+     *
+     * @param build Builds the summary Markdown.
+     */
+    summary(build) {
+        this.writer.summary(build);
     }
     /**
      * Run a callback inside a collapsible log group.
@@ -43,13 +89,15 @@ export class Logger {
      * @return Callback result.
      */
     async group(title, callback) {
-        this.info(this.ci ? `::group::${title}` : `== ${title}`);
+        if (!this.quiet) {
+            this.writer.startGroup(title);
+        }
         try {
             return await callback();
         }
         finally {
-            if (this.ci) {
-                this.info('::endgroup::');
+            if (!this.quiet) {
+                this.writer.endGroup();
             }
         }
     }

package/dist/package-meta.d.ts

@@ -76,6 +76,23 @@ export interface ReadPackageMetaInput {
  * @return Non-empty header values.
  */
 export declare function parseFileHeaders(input: ParseFileHeadersInput): HeaderValues;
+/**
+ * Find the line of a file header like "Version: 1.2.0", matched the same way
+ * as parseFileHeaders().
+ *
+ * @param contents File contents.
+ * @param header   Header name.
+ * @return Line number starting at 1, or null when the header isn't there.
+ */
+export declare function findFileHeaderLine(contents: string, header: string): number | null;
+/**
+ * Get the line number of a position in a text.
+ *
+ * @param contents Text.
+ * @param index    Character position.
+ * @return Line number starting at 1.
+ */
+export declare function getLineNumber(contents: string, index: number): number;
 /**
  * Parse the headers of a readme.txt or readme.md, the "Key: value" lines
  * between the title and the first section. Markdown emphasis around the
@@ -85,6 +102,15 @@ export declare function parseFileHeaders(input: ParseFileHeadersInput): HeaderVa
  * @return Non-empty header values keyed by the names in README_HEADERS.
  */
 export declare function parseReadmeHeaders(contents: string): HeaderValues;
+/**
+ * Find the line of a readme header like "Stable tag: 1.2.0", the line that
+ * parseReadmeHeaders() reads the value from.
+ *
+ * @param contents Readme contents.
+ * @param header   Header name from README_HEADERS.
+ * @return Line number starting at 1, or null when the header isn't there.
+ */
+export declare function findReadmeHeaderLine(contents: string, header: string): number | null;
 /**
  * Read the start of a file, where WordPress looks for the headers.
  *

package/dist/package-meta.js

@@ -82,11 +82,36 @@ export function parseFileHeaders(input) {
     ]);
     return Object.fromEntries(entries.filter(([, value]) => value));
 }
+function getFileHeaderPattern(header) {
+    return new RegExp(`^(?:[ \\t]*<\\?php)?[ \\t/*#@]*${escapeRegExp(header)}:(.*)$`, 'mi');
+}
 function matchFileHeader(contents, header) {
-    const pattern = new RegExp(`^(?:[ \\t]*<\\?php)?[ \\t/*#@]*${escapeRegExp(header)}:(.*)$`, 'mi');
-    const value = pattern.exec(contents)?.[1] ?? '';
+    const value = getFileHeaderPattern(header).exec(contents)?.[1] ?? '';
     return value.replace(/\s*(?:\*\/|\?>).*/, '').trim();
 }
+/**
+ * Find the line of a file header like "Version: 1.2.0", matched the same way
+ * as parseFileHeaders().
+ *
+ * @param contents File contents.
+ * @param header   Header name.
+ * @return Line number starting at 1, or null when the header isn't there.
+ */
+export function findFileHeaderLine(contents, header) {
+    const normalized = contents.replace(/\r\n?/g, '\n');
+    const match = getFileHeaderPattern(header).exec(normalized);
+    return match ? getLineNumber(normalized, match.index) : null;
+}
+/**
+ * Get the line number of a position in a text.
+ *
+ * @param contents Text.
+ * @param index    Character position.
+ * @return Line number starting at 1.
+ */
+export function getLineNumber(contents, index) {
+    return contents.slice(0, index).split('\n').length;
+}
 function escapeRegExp(text) {
     return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 }
@@ -99,19 +124,49 @@ function escapeRegExp(text) {
  * @return Non-empty header values keyed by the names in README_HEADERS.
  */
 export function parseReadmeHeaders(contents) {
-    const lines = contents.replace(/\r\n?/g, '\n').split('\n');
-    const firstSection = lines.findIndex((line, index) => index > 0 && /^\s*(==|##)/.test(line));
-    const headerLines = lines.slice(0, -1 === firstSection ? lines.length : firstSection);
     const values = {};
-    headerLines.forEach((line) => {
-        const match = /^[\s*_-]*([^:*_]+?)[*_]*\s*:[*_]*\s*(.*?)\s*$/.exec(line);
-        const header = README_HEADERS.find((name) => name.toLowerCase() === match?.[1]?.toLowerCase());
-        if (header && match?.[2] && !Object.hasOwn(values, header)) {
-            values[header] = match[2];
+    getReadmeHeaderLines(contents).forEach((line) => {
+        const match = matchReadmeHeader(line);
+        if (match && !Object.hasOwn(values, match.header)) {
+            values[match.header] = match.value;
         }
     });
     return values;
 }
+/**
+ * Find the line of a readme header like "Stable tag: 1.2.0", the line that
+ * parseReadmeHeaders() reads the value from.
+ *
+ * @param contents Readme contents.
+ * @param header   Header name from README_HEADERS.
+ * @return Line number starting at 1, or null when the header isn't there.
+ */
+export function findReadmeHeaderLine(contents, header) {
+    const index = getReadmeHeaderLines(contents).findIndex((line) => header === matchReadmeHeader(line)?.header);
+    return -1 === index ? null : index + 1;
+}
+/**
+ * Get the readme lines before the first section, where the headers are.
+ *
+ * @param contents Readme contents.
+ * @return Lines from the first line.
+ */
+function getReadmeHeaderLines(contents) {
+    const lines = contents.replace(/\r\n?/g, '\n').split('\n');
+    const firstSection = lines.findIndex((line, index) => index > 0 && /^\s*(==|##)/.test(line));
+    return lines.slice(0, -1 === firstSection ? lines.length : firstSection);
+}
+/**
+ * Match a readme header line. Markdown emphasis around the name is ignored.
+ *
+ * @param line Readme line.
+ * @return Header name from README_HEADERS and its value, or null when the line isn't a non-empty header.
+ */
+function matchReadmeHeader(line) {
+    const match = /^[\s*_-]*([^:*_]+?)[*_]*\s*:[*_]*\s*(.*?)\s*$/.exec(line);
+    const header = README_HEADERS.find((name) => name.toLowerCase() === match?.[1]?.toLowerCase());
+    return header && match?.[2] ? { header, value: match[2] } : null;
+}
 /**
  * Read the start of a file, where WordPress looks for the headers.
  *

package/dist/report.d.ts

@@ -0,0 +1,22 @@
+import type { Problem } from './errors.ts';
+import type { Logger } from './logger.ts';
+/**
+ * Log each problem as an error on its file and line, and list them in the
+ * summary of the run.
+ *
+ * @param logger      Logger.
+ * @param title       What failed, like the command name, for the summary.
+ * @param problems    Problems.
+ * @param description Text above the problems in the summary, if any.
+ */
+export declare function logProblems(logger: Logger, title: string, problems: Problem[], description?: string): void;
+/**
+ * Log an error thrown while running a command, and add it to the summary of
+ * the run. A ValidationError with problems is logged problem by problem, so
+ * that each one is reported on its own file and line.
+ *
+ * @param logger Logger.
+ * @param error  Thrown error.
+ * @param title  What failed, like the command name, for the summary.
+ */
+export declare function logError(logger: Logger, error: unknown, title?: string): void;

package/dist/report.js

@@ -0,0 +1,35 @@
+import { ValidationError } from "./errors.js";
+import { getErrorSummary, getProblemsSummary } from "./summary.js";
+/**
+ * Log each problem as an error on its file and line, and list them in the
+ * summary of the run.
+ *
+ * @param logger      Logger.
+ * @param title       What failed, like the command name, for the summary.
+ * @param problems    Problems.
+ * @param description Text above the problems in the summary, if any.
+ */
+export function logProblems(logger, title, problems, description = '') {
+    problems.forEach(({ message, ...annotation }) => logger.error(message, annotation));
+    logger.summary((context) => getProblemsSummary(context, title, problems, description));
+}
+/**
+ * Log an error thrown while running a command, and add it to the summary of
+ * the run. A ValidationError with problems is logged problem by problem, so
+ * that each one is reported on its own file and line.
+ *
+ * @param logger Logger.
+ * @param error  Thrown error.
+ * @param title  What failed, like the command name, for the summary.
+ */
+export function logError(logger, error, title = 'wp-release') {
+    const message = error instanceof Error ? error.message : String(error);
+    const problems = error instanceof ValidationError ? error.problems : [];
+    if (problems.length) {
+        logProblems(logger, title, problems);
+    }
+    else {
+        logger.error(message);
+        logger.summary(() => getErrorSummary(title, message));
+    }
+}

package/dist/summary.d.ts

@@ -0,0 +1,141 @@
+import type { ChecksumsResult } from './commands/checksums.ts';
+import type { SignResult } from './commands/sign.ts';
+import type { ZipResult } from './commands/zip.ts';
+import type { DeployOptions } from './deploy-options.ts';
+import type { SvnStatusEntry } from './svn.ts';
+import type { Problem } from './errors.ts';
+/**
+ * SVN host of the WordPress.org plugin repositories.
+ */
+export declare const WPORG_SVN_HOST = "https://plugins.svn.wordpress.org/";
+/**
+ * Number of files or SVN changes listed in a summary before the rest are
+ * counted.
+ */
+export declare const SUMMARY_LIST_LIMIT = 100;
+/**
+ * Where summary file paths are relative to.
+ */
+export interface SummaryContext {
+    /** Directory that file paths are shown relative to. */
+    workspace: string;
+}
+export interface DeploySummaryInput {
+    /** Resolved deploy options. */
+    options: DeployOptions;
+    /** Whether a commit was made. */
+    committed: boolean;
+    /** Revision of the commit. */
+    revision: number | null;
+    /** Deployed version. */
+    version: string | null;
+    /** Changed paths in the working copy. */
+    changes: SvnStatusEntry[];
+}
+/**
+ * Get the path of a file relative to the workspace.
+ *
+ * @param workspace Workspace directory.
+ * @param file      File path, absolute or relative to the working directory.
+ * @return Path with forward slashes, or null when it's outside the workspace.
+ */
+export declare function getWorkspacePath(workspace: string, file: string): string | null;
+/**
+ * Format text as inline code, with a fence that is longer than any backticks
+ * in the text.
+ *
+ * @param text Text.
+ * @return Markdown code span.
+ */
+export declare function formatCode(text: string): string;
+/**
+ * Format a Markdown table.
+ *
+ * @param header Column titles.
+ * @param rows   Cells of each row, already formatted as Markdown.
+ * @return Markdown table.
+ */
+export declare function formatTable(header: string[], rows: string[][]): string;
+/**
+ * Format a file path as code, relative to the workspace when it's inside it.
+ * Files aren't linked, since build directories and release files usually
+ * aren't in the repository.
+ *
+ * @param context Workspace directory.
+ * @param file    File path.
+ * @param line    Line in the file, if known.
+ * @return Markdown code.
+ */
+export declare function formatFile(context: SummaryContext, file: string, line?: number | null): string;
+/**
+ * Get the summary of a ZIP.
+ *
+ * @param context Workspace directory.
+ * @param result  ZIP and manifest paths and the number of files.
+ * @return Markdown summary.
+ */
+export declare function getZipSummary(context: SummaryContext, result: ZipResult): string;
+/**
+ * Get the summary of a checksums manifest.
+ *
+ * @param context Workspace directory.
+ * @param result  Manifest path and the number of hashed files.
+ * @return Markdown summary.
+ */
+export declare function getChecksumsSummary(context: SummaryContext, result: ChecksumsResult): string;
+/**
+ * Get the summary of signed files.
+ *
+ * @param context Workspace directory.
+ * @param result  Signature paths and the public key.
+ * @return Markdown summary.
+ */
+export declare function getSignSummary(context: SummaryContext, result: SignResult): string;
+/**
+ * Get the summary of a verify run where every file matches. Failed runs are
+ * summarized with their problems instead.
+ *
+ * @param context              Workspace directory.
+ * @param result               Verify result.
+ * @param result.checksumsPath Checksums manifest path.
+ * @param result.matched       Number of matching files.
+ * @return Markdown summary.
+ */
+export declare function getVerifySummary(context: SummaryContext, result: {
+    checksumsPath: string;
+    matched: number;
+}): string;
+/**
+ * Get the summary of a version check without mismatches.
+ *
+ * @param version Version that all sources match.
+ * @return Markdown summary.
+ */
+export declare function getVersionCheckSummary(version: string | null): string;
+/**
+ * Get the summary of failed checks, with the file and line of each problem.
+ * Problems after the list limit are counted instead of listed.
+ *
+ * @param context     Workspace directory.
+ * @param title       What failed, like the command name.
+ * @param problems    Problems.
+ * @param description Text above the problems, if any.
+ * @return Markdown summary.
+ */
+export declare function getProblemsSummary(context: SummaryContext, title: string, problems: Problem[], description?: string): string;
+/**
+ * Get the summary of a failed run.
+ *
+ * @param title   What failed, like the command name.
+ * @param message Error message.
+ * @return Markdown summary.
+ */
+export declare function getErrorSummary(title: string, message: string): string;
+/**
+ * Get the summary of a deploy, with the written paths, the commit and the
+ * SVN changes.
+ *
+ * @param input Deploy options and result.
+ * @return Markdown summary.
+ */
+export declare function getDeploySummary(input: DeploySummaryInput): string;