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

Static Dataflow Analyzer and Program Slicer for the R Programming Language

export declare const toolName = "flowr";
export interface FlowrCliOptions {
    'config-file': string;
    'config-json': string;
    'no-ansi': boolean;
    'r-path': string | undefined;
    'r-session-access': boolean;
    execute: string | undefined;
    help: boolean;
    port: number;
    script: string | undefined;
    server: boolean;
    verbose: boolean;
    version: boolean;
    ws: boolean;
    'default-engine': string;
    'engine.r-shell.disabled': boolean;
    'engine.r-shell.r-path': string | undefined;
    'engine.tree-sitter.disabled': boolean;
    'engine.tree-sitter.wasm-path': string | undefined;
    'engine.tree-sitter.tree-sitter-wasm-path': string | undefined;
    'engine.tree-sitter.lax': boolean;
}
export declare const optionHelp: ({
    header: string;
    content: string;
    optionList?: undefined;
} | {
    header: string;
    content: string[];
    optionList?: undefined;
} | {
    header: string;
    optionList: [{
        readonly name: "config-file";
        readonly type: StringConstructor;
        readonly description: "The name of the configuration file to use";
        readonly multiple: false;
    }, {
        readonly name: "config-json";
        readonly type: StringConstructor;
        readonly description: "The flowR configuration to use, as a JSON string";
        readonly multiple: false;
    }, {
        readonly name: "execute";
        readonly alias: "e";
        readonly type: StringConstructor;
        readonly description: "Execute the given command and exit. Use a semicolon \";\" to separate multiple commands.";
        readonly typeLabel: "{underline command}";
        readonly multiple: false;
    }, {
        readonly name: "help";
        readonly alias: "h";
        readonly type: BooleanConstructor;
        readonly description: "Print this usage guide (or the guide of the corresponding script)";
    }, {
        readonly name: "no-ansi";
        readonly type: BooleanConstructor;
        readonly description: "Disable ansi-escape-sequences in the output. Useful, if you want to redirect the output to a file.";
    }, {
        readonly name: "port";
        readonly type: NumberConstructor;
        readonly description: "The port to listen on, if --server is given.";
        readonly defaultValue: 1042;
        readonly typeLabel: "{underline port}";
    }, {
        readonly name: "r-path";
        readonly type: StringConstructor;
        readonly description: "The path to the R executable to use. Defaults to your PATH. This option is being phased out in favor of the engine configuration option \"engine.r-shell.r-path\", which should be used instead.";
        readonly multiple: false;
    }, {
        readonly name: "r-session-access";
        readonly type: BooleanConstructor;
        readonly description: "Allow to access the underlying R session when using flowR (security warning: this allows the execution of arbitrary R code!)";
    }, {
        readonly name: "script";
        readonly alias: "s";
        readonly type: StringConstructor;
        readonly description: `The sub-script to run (${string})`;
        readonly multiple: false;
        readonly defaultOption: true;
        readonly typeLabel: "{underline files}";
        readonly defaultValue: undefined;
    }, {
        readonly name: "server";
        readonly type: BooleanConstructor;
        readonly description: "Do not drop into a repl, but instead start a server on the given port (default: 1042) and listen for messages.";
    }, {
        readonly name: "verbose";
        readonly alias: "v";
        readonly type: BooleanConstructor;
        readonly description: "Run with verbose logging (will be passed to the corresponding script)";
    }, {
        readonly name: "version";
        readonly alias: "V";
        readonly type: BooleanConstructor;
        readonly description: "Provide information about the version of flowR as well as its underlying R system and exit.";
    }, {
        readonly name: "ws";
        readonly type: BooleanConstructor;
        readonly description: "If the server flag is set, use websocket for messaging";
    }, {
        readonly name: "engine.r-shell.disabled";
        readonly type: BooleanConstructor;
        readonly description: "Disable the R shell engine";
    }, {
        readonly name: "engine.r-shell.r-path";
        readonly type: StringConstructor;
        readonly description: "The path to the R executable to use. Defaults to your PATH.";
        readonly multiple: false;
    }, {
        readonly name: "engine.tree-sitter.disabled";
        readonly type: BooleanConstructor;
        readonly description: "Disable the tree-sitter engine";
    }, {
        readonly name: "engine.tree-sitter.wasm-path";
        readonly type: StringConstructor;
        readonly description: "The path to the tree-sitter-r WASM binary to use. Defaults to the one shipped with flowR.";
        readonly multiple: false;
    }, {
        readonly name: "engine.tree-sitter.tree-sitter-wasm-path";
        readonly type: StringConstructor;
        readonly description: "The path to the tree-sitter WASM binary to use. Defaults to the path specified by the tree-sitter package.";
        readonly multiple: false;
    }, {
        readonly name: "engine.tree-sitter.lax";
        readonly type: BooleanConstructor;
        readonly description: "Use the lax parser for parsing R code (allowing for syntax errors).";
        readonly multiple: false;
    }, {
        readonly name: "default-engine";
        readonly type: StringConstructor;
        readonly description: "The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from the specified list will be used.";
        readonly multiple: false;
    }];
    content?: undefined;
})[];