@eagleoutice/flowr 1.4.2 → 1.5.0

package/cli/repl/commands/commands.js

@@ -1,142 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.longestCommandName = exports.asOptionName = exports.getCommand = exports.getCommandNames = exports.helpCommand = void 0;
-const quit_1 = require("./quit");
-const common_1 = require("../../common");
-const execute_1 = require("../execute");
-const args_1 = require("../../../util/args");
-const prompt_1 = require("../prompt");
-const statistics_1 = require("../../../statistics");
-const version_1 = require("./version");
-const parse_1 = require("./parse");
-const assert_1 = require("../../../util/assert");
-const execute_2 = require("./execute");
-const normalize_1 = require("./normalize");
-const dataflow_1 = require("./dataflow");
-const cfg_1 = require("./cfg");
-function printHelpForScript(script, f) {
-    const base = `  ${(0, statistics_1.bold)(padCmd(':' + script[0]), f)}${script[1].description}`;
-    if (script[1].aliases.length === 0) {
-        return base;
-    }
-    const aliases = script[1].aliases;
-    return `${base} (alias${aliases.length > 1 ? 'es' : ''}: ${aliases.map(a => (0, statistics_1.bold)(':' + a, f)).join(', ')})`;
-}
-exports.helpCommand = {
-    description: 'Show help information',
-    script: false,
-    usageExample: ':help',
-    aliases: ['h', '?'],
-    fn: output => {
-        initCommandMapping();
-        output.stdout(`
-You can always just enter R expressions which get evaluated right away:
-${prompt_1.rawPrompt} ${(0, statistics_1.bold)('1 + 1', output.formatter)}
-${(0, statistics_1.italic)('[1] 2', output.formatter)}
-
-Besides that, you can use the following commands. The scripts ${(0, statistics_1.italic)('can', output.formatter)} accept further arguments. There are the following basic commands:
-${Array.from(Object.entries(commands())).filter(([, { script }]) => !script).map(c => printHelpForScript(c, output.formatter)).join('\n')}
-
-Furthermore, you can directly call the following scripts which accept arguments. If you are unsure, try to add ${(0, statistics_1.italic)('--help', output.formatter)} after the command.
-${Array.from(Object.entries(commands())).filter(([, { script }]) => script).map(([command, { description }]) => `  ${(0, statistics_1.bold)(padCmd(':' + command), output.formatter)}${description}`).join('\n')}
-
-You can combine commands by separating them with a semicolon ${(0, statistics_1.bold)(';', output.formatter)}.
-`);
-    }
-};
-/**
- * All commands that should be available in the REPL.
- */
-const _commands = {
-    'help': exports.helpCommand,
-    'quit': quit_1.quitCommand,
-    'version': version_1.versionCommand,
-    'execute': execute_2.executeCommand,
-    'parse': parse_1.parseCommand,
-    'normalize': normalize_1.normalizeCommand,
-    'normalize*': normalize_1.normalizeStarCommand,
-    'dataflow': dataflow_1.dataflowCommand,
-    'dataflow*': dataflow_1.dataflowStarCommand,
-    'controlflow': cfg_1.controlflowCommand,
-    'controlflow*': cfg_1.controlflowStarCommand
-};
-let commandsInitialized = false;
-function commands() {
-    if (commandsInitialized) {
-        return _commands;
-    }
-    commandsInitialized = true;
-    for (const [script, { target, description, type }] of Object.entries(common_1.scripts)) {
-        if (type === 'master script') {
-            _commands[script] = {
-                description,
-                aliases: [],
-                script: true,
-                usageExample: `:${script} --help`,
-                fn: async (output, _s, remainingLine) => {
-                    await (0, execute_1.waitOnScript)(`${__dirname}/../../${target}`, (0, args_1.splitAtEscapeSensitive)(remainingLine), stdio => (0, execute_1.stdioCaptureProcessor)(stdio, msg => output.stdout(msg), msg => output.stderr(msg)));
-                }
-            };
-        }
-    }
-    return _commands;
-}
-/**
- * The names of all commands including their aliases (but without the leading `:`)
- */
-function getCommandNames() {
-    if (commandNames === undefined) {
-        initCommandMapping();
-    }
-    return commandNames;
-}
-exports.getCommandNames = getCommandNames;
-let commandNames = undefined;
-// maps command names or aliases to the actual command name
-let commandMapping = undefined;
-function initCommandMapping() {
-    commandMapping = {};
-    commandNames = [];
-    for (const [command, { aliases }] of Object.entries(commands())) {
-        (0, assert_1.guard)(commandMapping[command] === undefined, `Command ${command} is already registered!`);
-        commandMapping[command] = command;
-        for (const alias of aliases) {
-            (0, assert_1.guard)(commandMapping[alias] === undefined, `Command (alias) ${alias} is already registered!`);
-            commandMapping[alias] = command;
-        }
-        commandNames.push(command);
-        commandNames.push(...aliases);
-    }
-}
-/**
- * Get the command for a given command name or alias.
- * @param command - The name of the command (without the leading `:`)
- */
-function getCommand(command) {
-    if (commandMapping === undefined) {
-        initCommandMapping();
-    }
-    return commands()[commandMapping[command]];
-}
-exports.getCommand = getCommand;
-function asOptionName(argument) {
-    if (argument.length == 1) {
-        return `-${argument}`;
-    }
-    else {
-        return `--${argument}`;
-    }
-}
-exports.asOptionName = asOptionName;
-let _longestCommandName = undefined;
-function longestCommandName() {
-    if (_longestCommandName === undefined) {
-        _longestCommandName = Array.from(Object.keys(commands()), k => k.length).reduce((p, n) => Math.max(p, n), 0);
-    }
-    return _longestCommandName;
-}
-exports.longestCommandName = longestCommandName;
-function padCmd(string) {
-    return String(string).padEnd(longestCommandName() + 2, ' ');
-}
-//# sourceMappingURL=commands.js.map

package/cli/repl/commands/dataflow.d.ts

@@ -1,3 +0,0 @@
-import type { ReplCommand } from './main';
-export declare const dataflowCommand: ReplCommand;
-export declare const dataflowStarCommand: ReplCommand;

package/cli/repl/commands/dataflow.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataflowStarCommand = exports.dataflowCommand = void 0;
-const core_1 = require("../../../core");
-const r_bridge_1 = require("../../../r-bridge");
-const dfg_1 = require("../../../util/mermaid/dfg");
-async function dataflow(shell, remainingLine) {
-    return await new core_1.SteppingSlicer({
-        stepOfInterest: 'dataflow',
-        shell,
-        request: (0, r_bridge_1.requestFromInput)(remainingLine.trim())
-    }).allRemainingSteps();
-}
-exports.dataflowCommand = {
-    description: `Get mermaid code for the dataflow graph of R code, start with '${r_bridge_1.fileProtocol}' to indicate a file`,
-    usageExample: ':dataflow',
-    aliases: ['d', 'df'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        const result = await dataflow(shell, remainingLine);
-        output.stdout((0, dfg_1.graphToMermaid)(result.dataflow.graph, result.normalize.idMap, undefined, undefined, false));
-    }
-};
-exports.dataflowStarCommand = {
-    description: `Get a mermaid url of the dataflow graph of R code, start with '${r_bridge_1.fileProtocol}' to indicate a file`,
-    usageExample: ':dataflow*',
-    aliases: ['d*', 'df*'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        const result = await dataflow(shell, remainingLine);
-        output.stdout((0, dfg_1.graphToMermaidUrl)(result.dataflow.graph, result.normalize.idMap, false));
-    }
-};
-//# sourceMappingURL=dataflow.js.map

package/cli/repl/commands/execute.d.ts

@@ -1,4 +0,0 @@
-import type { RShell } from '../../../r-bridge';
-import type { ReplCommand, ReplOutput } from './main';
-export declare function executeRShellCommand(output: ReplOutput, shell: RShell, statement: string): Promise<void>;
-export declare const executeCommand: ReplCommand;

package/cli/repl/commands/execute.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeCommand = exports.executeRShellCommand = void 0;
-const statistics_1 = require("../../../statistics");
-async function executeRShellCommand(output, shell, statement) {
-    try {
-        const result = await shell.sendCommandWithOutput(statement, {
-            from: 'both',
-            automaticallyTrimOutput: true
-        });
-        output.stdout(`${(0, statistics_1.italic)(result.join('\n'), output.formatter)}\n`);
-    }
-    catch (e) {
-        output.stderr(`Error while executing '${statement}': ${e.message}`);
-    }
-}
-exports.executeRShellCommand = executeRShellCommand;
-exports.executeCommand = {
-    description: 'Execute the given code as R code (essentially similar to using now command)',
-    usageExample: ':execute',
-    aliases: ['e', 'r'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        await executeRShellCommand(output, shell, remainingLine);
-    }
-};
-//# sourceMappingURL=execute.js.map

package/cli/repl/commands/index.d.ts

@@ -1,2 +0,0 @@
-export * from './main';
-export * from './commands';

package/cli/repl/commands/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./main"), exports);
-__exportStar(require("./commands"), exports);
-//# sourceMappingURL=index.js.map

package/cli/repl/commands/main.d.ts

@@ -1,39 +0,0 @@
-import type { RShell } from '../../../r-bridge';
-import type { OutputFormatter } from '../../../statistics';
-/**
- * Defines the main interface for output of the repl.
- * This allows us to redirect it (e.g., in the case of a server connection or tests).
- *
- * The formatter allows to dynamically change the use of ansi escape sequences (see {@link OutputFormatter})
- *
- * @see standardReplOutput
- */
-export interface ReplOutput {
-    formatter: OutputFormatter;
-    stdout(msg: string): void;
-    stderr(msg: string): void;
-}
-/**
- * Default repl output that redirects everything to the stdout and stderror channels (linked to `console`).
- * @see ReplOutput
- */
-export declare const standardReplOutput: ReplOutput;
-/**
- * Content of a single command in the repl.
- * The command may execute an external script or simply call *flowR* functions.
- */
-export interface ReplCommand {
-    /** Aliases of the command (without the leading colon), every alias must be unique (this is checked at runtime) */
-    aliases: string[];
-    /** A human-readable description of what the command does */
-    description: string;
-    /** Does the command invoke another script? this is mainly used to automatically generate two separate lists when asking for help */
-    script: boolean;
-    /** Example of how to use the command, for example `:slicer --help` */
-    usageExample: string;
-    /**
-     * Function to execute when the command is invoked, it must not write to the command line but instead use the output handler.
-     * Furthermore, it has to obey the formatter defined in the {@link ReplOutput}.
-     */
-    fn: (output: ReplOutput, shell: RShell, remainingLine: string) => Promise<void> | void;
-}

package/cli/repl/commands/main.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.standardReplOutput = void 0;
-const statistics_1 = require("../../../statistics");
-/**
- * Default repl output that redirects everything to the stdout and stderror channels (linked to `console`).
- * @see ReplOutput
- */
-exports.standardReplOutput = {
-    formatter: statistics_1.formatter,
-    stdout: console.log,
-    stderr: console.error
-};
-//# sourceMappingURL=main.js.map

package/cli/repl/commands/normalize.d.ts

@@ -1,3 +0,0 @@
-import type { ReplCommand } from './main';
-export declare const normalizeCommand: ReplCommand;
-export declare const normalizeStarCommand: ReplCommand;

package/cli/repl/commands/normalize.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeStarCommand = exports.normalizeCommand = void 0;
-const core_1 = require("../../../core");
-const r_bridge_1 = require("../../../r-bridge");
-const mermaid_1 = require("../../../util/mermaid");
-async function normalize(shell, remainingLine) {
-    return await new core_1.SteppingSlicer({
-        stepOfInterest: 'normalize',
-        shell,
-        request: (0, r_bridge_1.requestFromInput)(remainingLine.trim())
-    }).allRemainingSteps();
-}
-exports.normalizeCommand = {
-    description: `Get mermaid code for the normalized AST of R code, start with '${r_bridge_1.fileProtocol}' to indicate a file`,
-    usageExample: ':normalize',
-    aliases: ['n'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        const result = await normalize(shell, remainingLine);
-        output.stdout((0, mermaid_1.normalizedAstToMermaid)(result.normalize.ast));
-    }
-};
-exports.normalizeStarCommand = {
-    description: `Get a mermaid url of the normalized AST of R code, start with '${r_bridge_1.fileProtocol}' to indicate a file`,
-    usageExample: ':normalize',
-    aliases: ['n*'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        const result = await normalize(shell, remainingLine);
-        output.stdout((0, mermaid_1.normalizedAstToMermaidUrl)(result.normalize.ast));
-    }
-};
-//# sourceMappingURL=normalize.js.map

package/cli/repl/commands/parse.d.ts

@@ -1,2 +0,0 @@
-import type { ReplCommand } from './main';
-export declare const parseCommand: ReplCommand;

package/cli/repl/commands/parse.js

@@ -1,109 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCommand = void 0;
-const r_bridge_1 = require("../../../r-bridge");
-const internal_1 = require("../../../r-bridge/lang-4.x/ast/parser/xml/internal");
-const core_1 = require("../../../core");
-const format_1 = require("../../../r-bridge/lang-4.x/ast/parser/json/format");
-const parser_1 = require("../../../r-bridge/lang-4.x/ast/parser/json/parser");
-function toDepthMap(xml) {
-    const root = (0, r_bridge_1.getKeysGuarded)(xml, "exprlist" /* RawRType.ExpressionList */);
-    const visit = [{ depth: 0, node: root }];
-    const result = [];
-    while (visit.length > 0) {
-        const current = visit.pop();
-        if (current === undefined) {
-            continue;
-        }
-        const children = current.node[r_bridge_1.childrenKey] ?? [];
-        result.push({ ...current, leaf: children.length === 0 });
-        children.reverse();
-        const nextDepth = current.depth + 1;
-        visit.push(...children.map(c => ({ depth: nextDepth, node: c })));
-    }
-    return result;
-}
-function lastElementInNesting(i, list, depth) {
-    for (let j = i + 1; j < list.length; j++) {
-        if (list[j].depth < depth) {
-            return true;
-        }
-        if (list[j].depth === depth) {
-            return false;
-        }
-    }
-    // only more deeply nested come after
-    return true;
-}
-function initialIndentation(i, depth, deadDepths, nextDepth, list, f) {
-    let result = `${i === 0 ? '' : '\n'}${f.getFormatString({ style: 2 /* FontStyles.Faint */ })}`;
-    // we know there never is something on the same level as the expression list
-    for (let d = 1; d < depth; d++) {
-        result += deadDepths.has(d) ? '  ' : '│ ';
-    }
-    if (nextDepth < depth) {
-        result += '╰ ';
-    }
-    else if (i > 0) {
-        // check if we are maybe the last one with this depth until someone with a lower depth comes around
-        const isLast = lastElementInNesting(i, list, depth);
-        result += isLast ? '╰ ' : '├ ';
-        if (isLast) {
-            deadDepths.add(depth);
-        }
-    }
-    return result;
-}
-function retrieveLocationString(locationRaw) {
-    const extracted = (0, internal_1.extractLocation)(locationRaw);
-    if (extracted.start.line === extracted.end.line && extracted.start.column === extracted.end.column) {
-        return ` (${extracted.start.line}:${extracted.start.column})`;
-    }
-    else {
-        return ` (${extracted.start.line}:${extracted.start.column}─${extracted.end.line}:${extracted.end.column})`;
-    }
-}
-function depthListToTextTree(list, f) {
-    let result = '';
-    const deadDepths = new Set();
-    let i = 0;
-    for (const { depth, node, leaf } of list) {
-        const nextDepth = i + 1 < list.length ? list[i + 1].depth : 0;
-        deadDepths.delete(depth);
-        result += initialIndentation(i, depth, deadDepths, nextDepth, list, f);
-        result += f.reset();
-        const raw = (0, internal_1.objectWithArrUnwrap)(node);
-        const content = raw[r_bridge_1.contentKey];
-        const locationRaw = raw[r_bridge_1.attributesKey];
-        let location = '';
-        if (locationRaw !== undefined) {
-            location = retrieveLocationString(locationRaw);
-        }
-        const type = (0, internal_1.getTokenType)(node);
-        if (leaf) {
-            const suffix = `${f.format(content ? JSON.stringify(content) : '', { style: 1 /* FontStyles.Bold */ })}${f.format(location, { style: 3 /* FontStyles.Italic */ })}`;
-            result += `${type} ${suffix}`;
-        }
-        else {
-            result += f.format(type, { style: 1 /* FontStyles.Bold */ });
-        }
-        i++;
-    }
-    return result;
-}
-exports.parseCommand = {
-    description: `Prints ASCII Art of the parsed, unmodified AST, start with '${r_bridge_1.fileProtocol}' to indicate a file`,
-    usageExample: ':parse',
-    aliases: ['p'],
-    script: false,
-    fn: async (output, shell, remainingLine) => {
-        const result = await new core_1.SteppingSlicer({
-            stepOfInterest: 'parse',
-            shell,
-            request: (0, r_bridge_1.requestFromInput)((0, r_bridge_1.removeRQuotes)(remainingLine.trim()))
-        }).allRemainingSteps();
-        const object = (0, parser_1.convertPreparedParsedData)((0, format_1.prepareParsedData)(result.parse));
-        output.stdout(depthListToTextTree(toDepthMap(object), output.formatter));
-    }
-};
-//# sourceMappingURL=parse.js.map

package/cli/repl/commands/quit.d.ts

@@ -1,2 +0,0 @@
-import type { ReplCommand } from './main';
-export declare const quitCommand: ReplCommand;

package/cli/repl/commands/quit.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.quitCommand = void 0;
-const log_1 = require("../../../util/log");
-exports.quitCommand = {
-    description: 'End the repl',
-    aliases: ['q', 'exit'],
-    usageExample: ':quit',
-    script: false,
-    fn: () => {
-        log_1.log.info('bye');
-        process.exit(0);
-    }
-};
-//# sourceMappingURL=quit.js.map

package/cli/repl/commands/version.d.ts

@@ -1,16 +0,0 @@
-import type { ReplCommand, ReplOutput } from './main';
-import { RShell } from '../../../r-bridge';
-type Version = `${number}.${number}.${number}`;
-/**
- * Describes the version of flowR and the used R interpreter.
- */
-export interface VersionInformation {
-    /** The version of flowR */
-    flowr: Version;
-    /** The version of R identified by the underlying {@link RShell} */
-    r: Version | 'unknown';
-}
-export declare function retrieveVersionInformation(shell?: RShell): Promise<VersionInformation>;
-export declare function printVersionInformation(output: ReplOutput, shell?: RShell): Promise<void>;
-export declare const versionCommand: ReplCommand;
-export {};

package/cli/repl/commands/version.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.versionCommand = exports.printVersionInformation = exports.retrieveVersionInformation = void 0;
-const r_bridge_1 = require("../../../r-bridge");
-const package_json_1 = require("../../../../package.json");
-const assert_1 = require("../../../util/assert");
-const versionRegex = /^\d+\.\d+\.\d+/m;
-async function retrieveVersionInformation(shell) {
-    if (shell === undefined) {
-        shell = new r_bridge_1.RShell();
-        process.on('exit', () => shell.close());
-    }
-    const flowr = package_json_1.version;
-    const r = (await shell.usedRVersion())?.format() ?? 'unknown';
-    (0, assert_1.guard)(versionRegex.test(flowr), `flowR version ${flowr} does not match the expected format!`);
-    (0, assert_1.guard)(r === 'unknown' || versionRegex.test(r), `R version ${r} does not match the expected format!`);
-    return { flowr: flowr, r: r };
-}
-exports.retrieveVersionInformation = retrieveVersionInformation;
-async function printVersionInformation(output, shell) {
-    const { flowr, r } = await retrieveVersionInformation(shell);
-    output.stdout(`flowR: ${flowr}`);
-    output.stdout(`R: ${r}`);
-}
-exports.printVersionInformation = printVersionInformation;
-exports.versionCommand = {
-    description: 'Prints the version of flowR as well as the current version of R',
-    aliases: [],
-    usageExample: ':version',
-    script: false,
-    fn: (output, shell) => printVersionInformation(output, shell)
-};
-//# sourceMappingURL=version.js.map

package/cli/repl/core.d.ts

@@ -1,41 +0,0 @@
-/// <reference types="node" />
-/**
- * Basically a helper file to allow the main 'flowr' script (located in the source root) to provide its repl
- *
- * @module
- */
-import { RShell } from '../../r-bridge';
-import type { ReplOutput } from './commands';
-import * as readline from 'readline';
-/**
- * Used by the repl to provide automatic completions for a given (partial) input line
- */
-export declare function replCompleter(line: string): [string[], string];
-export declare const DEFAULT_REPL_READLINE_CONFIGURATION: readline.ReadLineOptions;
-/**
- * This function interprets the given `expr` as a REPL command (see {@link repl} for more on the semantics).
- *
- * @param output   - Defines two methods that every function in the repl uses to output its data.
- * @param expr     - The expression to process.
- * @param shell    - The {@link RShell} to use (see {@link repl}).
- */
-export declare function replProcessAnswer(output: ReplOutput, expr: string, shell: RShell): Promise<void>;
-/**
- * Provides a never-ending repl (read-evaluate-print loop) processor that can be used to interact with a {@link RShell} as well as all flowR scripts.
- *
- * The repl allows for two kinds of inputs:
- * - Starting with a colon `:`, indicating a command (probe `:help`, and refer to {@link commands}) </li>
- * - Starting with anything else, indicating default R code to be directly executed. If you kill the underlying shell, that is on you! </li>
- *
- * @param shell     - The shell to use, if you do not pass one it will automatically create a new one with the `revive` option set to 'always'
- * @param rl        - A potentially customized readline interface to be used for the repl to *read* from the user, we write the output with the {@link ReplOutput | `output` } interface.
- *                    If you want to provide a custom one but use the same `completer`, refer to {@link replCompleter}.
- *                    For the default arguments, see {@link DEFAULT_REPL_READLINE_CONFIGURATION}.
- * @param output    - Defines two methods that every function in the repl uses to output its data.
- * @param historyFile - The file to use for persisting the repl's history. Passing undefined causes history not to be saved.
- *
- * For the execution, this function makes use of {@link replProcessAnswer}
- *
- */
-export declare function repl(shell?: RShell, rl?: readline.Interface, output?: ReplOutput, historyFile?: string | undefined): Promise<void>;
-export declare function loadReplHistory(historyFile: string): string[] | undefined;