@eagleoutice/flowr/cli/common/script.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

/**
 * The goal of this module is simply to streamline the creation of new scripts.
 * @module
 */
import { scripts } from './scripts-info';
import type { CommonOptions } from './options';
/**
 * Just a helping data structure to allow the user to provide example usages of the respective script.
 * The subtitle will be displayed next to the title.
 */
export interface HelpContent {
    subtitle: string;
    examples: string[];
}
/**
 * Automatically generates a uniform help from a given script (see {@link scripts}).
 * Additionally, you can pass usage examples that may make use of the formatting instructions `{italic x}` and `{bold x}`.
 */
export declare function helpForOptions(script: keyof typeof scripts, content: HelpContent): string;
/**
 * Processes the command line arguments for a given script.
 */
export declare function processCommandLineArgs<T extends CommonOptions>(script: keyof typeof scripts, requireAdditionally: (keyof T)[], help: HelpContent): T;