mdat/dist/readme/rules/utilities/cli-help/help-string-to-object.d.ts

CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.

import { type ProgramInfo } from './parsers/index';
/**
 * Tries to parse a help string into an object through a process of trial and
 * error with the available parsers.
 *
 * Generally, there's no way to know which framework was used to generate a
 * particular CLI tool without inspecting the output for particular formatting
 * patterns.
 */
export declare function helpStringToObject(helpString: string): ProgramInfo | undefined;