@eagleoutice/flowr 2.6.2 → 2.7.0

package/documentation/print-search-wiki.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const shell_1 = require("../r-bridge/shell");
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_files_1 = require("./doc-util/doc-files");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-const doc_search_1 = require("./doc-util/doc-search");
-const flowr_search_builder_1 = require("../search/flowr-search-builder");
-const vertex_1 = require("../dataflow/graph/vertex");
-const doc_types_1 = require("./doc-util/doc-types");
-const path_1 = __importDefault(require("path"));
-const flowr_search_executor_1 = require("../search/flowr-search-executor");
-async function getText(shell) {
-    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
-    const types = (0, doc_types_1.getTypesFromFolder)({
-        rootFolder: path_1.default.resolve('./src/search/'),
-        inlineTypes: doc_types_1.mermaidHide
-    });
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'search API', rVersion: rversion })}
-
-This page briefly summarizes flowR's search API which provides a set of functions to search for nodes in the [Dataflow Graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow%20Graph) and the 
-[Normalized AST](${doc_files_1.FlowrWikiBaseRef}/Normalized%20AST) of a given R code (the search will always consider both, with respect to your search query).
-Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
-Within code, you can execute a search using the ${(0, doc_types_1.shortLink)(flowr_search_executor_1.runSearch.name, types.info)} function.
-
-For an initial motivation, let's have a look at the following example:
-
-${await (0, doc_search_1.showSearch)(shell, 'x <- x * x', flowr_search_builder_1.Q.var('x'))}
-
-This returns all references to the variable \`x\` in the code.
-However, the search API is not limited to simple variable references and can do much more.
-
-For example, let's have every definition of \`x\` in the code but the first one:
-
-${await (0, doc_search_1.showSearch)(shell, 'x <- x * x\nprint(x)\nx <- y <- 3\nprint(x)\nx <- 2', flowr_search_builder_1.Q.var('x').filter(vertex_1.VertexType.VariableDefinition).skip(1))}
-
-In summary, every search has two parts. It is initialized with a _generator_ (such as \`Q.var('x')\`)
-and can be further refined with _transformers_ or _modifiers_.
-Such queries can be constructed starting from the ${(0, doc_types_1.shortLink)('Q', types.info)} object (backed by ${(0, doc_types_1.shortLink)('FlowrSearchGenerator', types.info)}) and
-are fully serializable so you can use them when communicating with the [Query API](${doc_files_1.FlowrWikiBaseRef}/Query%20API).
-
-We offer the following generators:
-
-${Object.keys(flowr_search_builder_1.Q).sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchGenerator::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchGenerator::${key}`, types.info)}`).join('\n')}
-
-Likewise, we have a palette of _transformers_ and _modifiers_:
-
-${
-    /* let's iterate over all methods of FlowrSearchBuilder */
-    Object.getOwnPropertyNames(Object.getPrototypeOf(new flowr_search_builder_1.FlowrSearchBuilder(undefined)))
-        .filter(n => n !== 'constructor').sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchBuilder::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchBuilder::${key}`, types.info)}`).join('\n')}
-
-Every search (and consequently the search pipeline) works with an array of ${(0, doc_types_1.shortLink)('FlowrSearchElement', types.info)} (neatly wrapped in ${(0, doc_types_1.shortLink)('FlowrSearchElements', types.info)}).
-Hence, even operations such as \`.first\` or \`.last\` return an array of elements (albeit with a single or no element).
-The search API does its best to stay typesafe wrt. to the return type and the transformers in use. 
-In addition, it offers optimizer passes to optimize the search pipeline before execution.
-They are executed with \`.build\` which may happen automatically, whenever you want to run a search using ${(0, doc_types_1.shortLink)('runSearch', types.info)}.
-
-`;
-}
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    const shell = new shell_1.RShell();
-    void getText(shell).then(str => {
-        console.log(str);
-    }).finally(() => {
-        shell.close();
-    });
-}
-//# sourceMappingURL=print-search-wiki.js.map

package/util/formats/adapter-format.d.ts

@@ -1,6 +0,0 @@
-import type { RParseRequest } from '../../r-bridge/retriever';
-export interface FileAdapter {
-    convertRequest(request: RParseRequest): RParseRequest;
-}
-export type SupportedFormats = 'R' | 'Rmd';
-export type SupportedDocumentTypes = '.r' | '.rmd';

package/util/formats/adapter-format.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=adapter-format.js.map

package/util/formats/adapter.d.ts

@@ -1,27 +0,0 @@
-import type { RParseRequest, RParseRequestFromText } from '../../r-bridge/retriever';
-import type { SupportedFormats } from './adapter-format';
-export declare const FileAdapters: {
-    readonly R: {
-        convertRequest: (request: RParseRequest) => RParseRequest;
-    };
-    readonly Rmd: {
-        convertRequest: (request: RParseRequest) => RParseRequestFromText<import("./adapters/rmd-adapter").RmdInfo>;
-    };
-};
-export declare const DocumentTypeToFormat: {
-    readonly '.r': "R";
-    readonly '.rmd': "Rmd";
-};
-export type AdapterReturnTypes = ReturnType<typeof FileAdapters[keyof typeof FileAdapters]['convertRequest']>;
-/**
- * Produce a parse request from a file path
- */
-export declare function requestFromFile(path: string): AdapterReturnTypes;
-/**
- * Produce a parse request from a text input
- */
-export declare function requestFromText(text: string, typeHint?: SupportedFormats): AdapterReturnTypes;
-/**
- * Infer the file type from a parse request, using file extension or info hints
- */
-export declare function inferFileType(request: RParseRequest): keyof typeof FileAdapters;

package/util/formats/adapter.js

@@ -1,58 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentTypeToFormat = exports.FileAdapters = void 0;
-exports.requestFromFile = requestFromFile;
-exports.requestFromText = requestFromText;
-exports.inferFileType = inferFileType;
-const r_adapter_1 = require("./adapters/r-adapter");
-const path_1 = __importDefault(require("path"));
-const rmd_adapter_1 = require("./adapters/rmd-adapter");
-exports.FileAdapters = {
-    'R': r_adapter_1.RAdapter,
-    'Rmd': rmd_adapter_1.RmdAdapter
-};
-exports.DocumentTypeToFormat = {
-    '.r': 'R',
-    '.rmd': 'Rmd'
-};
-/**
- * Produce a parse request from a file path
- */
-function requestFromFile(path) {
-    const baseRequest = {
-        request: 'file',
-        content: path
-    };
-    const type = inferFileType(baseRequest);
-    return exports.FileAdapters[type].convertRequest(baseRequest);
-}
-/**
- * Produce a parse request from a text input
- */
-function requestFromText(text, typeHint) {
-    const baseRequest = {
-        request: 'text',
-        content: text,
-        info: typeHint ? { type: typeHint } : undefined
-    };
-    const type = inferFileType(baseRequest);
-    return exports.FileAdapters[type].convertRequest(baseRequest);
-}
-/**
- * Infer the file type from a parse request, using file extension or info hints
- */
-function inferFileType(request) {
-    if (request.request === 'text') {
-        return request.info ? request.info.type : 'R';
-    }
-    const type = path_1.default.extname(request.content).toLowerCase();
-    // Fallback to default if unknown
-    if (!Object.hasOwn(exports.DocumentTypeToFormat, type)) {
-        return 'R';
-    }
-    return exports.DocumentTypeToFormat[type];
-}
-//# sourceMappingURL=adapter.js.map

package/util/formats/adapters/r-adapter.d.ts

@@ -1,4 +0,0 @@
-import type { RParseRequest } from '../../../r-bridge/retriever';
-export declare const RAdapter: {
-    convertRequest: (request: RParseRequest) => RParseRequest;
-};

package/util/formats/adapters/r-adapter.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RAdapter = void 0;
-exports.RAdapter = {
-    convertRequest: (request) => request
-};
-//# sourceMappingURL=r-adapter.js.map

package/util/formats/adapters/rmd-adapter.d.ts

@@ -1,35 +0,0 @@
-import { type Node } from 'commonmark';
-import type { RParseRequest, RParseRequestFromText } from '../../../r-bridge/retriever';
-export interface CodeBlock {
-    options: string;
-    code: string;
-}
-export type CodeBlockEx = CodeBlock & {
-    startpos: {
-        line: number;
-        col: number;
-    };
-};
-export interface RmdInfo {
-    type: 'Rmd';
-    blocks: CodeBlock[];
-    options: object;
-}
-export declare const RmdAdapter: {
-    convertRequest: (request: RParseRequest) => RParseRequestFromText<RmdInfo>;
-};
-/**
- * Checks whether a CommonMark node is an R code block
- */
-export declare function isRCodeBlock(node: Node): node is Node & {
-    literal: string;
-    info: string;
-};
-/**
- * Restores an Rmd file from code blocks, filling non-code lines with empty lines
- */
-export declare function restoreBlocksWithoutMd(blocks: CodeBlockEx[], totalLines: number): string;
-/**
- * Parses the options of an R code block from its header and content
- */
-export declare function parseCodeBlockOptions(header: string, content: string): string;

package/util/formats/adapters/rmd-adapter.js

@@ -1,100 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RmdAdapter = void 0;
-exports.isRCodeBlock = isRCodeBlock;
-exports.restoreBlocksWithoutMd = restoreBlocksWithoutMd;
-exports.parseCodeBlockOptions = parseCodeBlockOptions;
-const fs_1 = __importDefault(require("fs"));
-const commonmark_1 = require("commonmark");
-const gray_matter_1 = __importDefault(require("gray-matter"));
-const assert_1 = require("../../assert");
-exports.RmdAdapter = {
-    convertRequest: (request) => {
-        // Read and Parse Markdown
-        const raw = request.request === 'text'
-            ? request.content
-            : fs_1.default.readFileSync(request.content, 'utf-8').toString();
-        const parser = new commonmark_1.Parser();
-        const ast = parser.parse(raw);
-        // Parse Frontmatter
-        const frontmatter = (0, gray_matter_1.default)(raw);
-        // Parse Codeblocks
-        const walker = ast.walker();
-        const blocks = [];
-        let e;
-        while ((e = walker.next())) {
-            const node = e.node;
-            if (!isRCodeBlock(node)) {
-                continue;
-            }
-            blocks.push({
-                code: node.literal,
-                options: parseCodeBlockOptions(node.info, node.literal),
-                startpos: { line: node.sourcepos[0][0] + 1, col: 0 }
-            });
-        }
-        return {
-            request: 'text',
-            content: restoreBlocksWithoutMd(blocks, countNewlines(raw)),
-            info: {
-                // eslint-disable-next-line unused-imports/no-unused-vars
-                blocks: blocks.map(({ startpos, ...block }) => block),
-                options: frontmatter.data,
-                type: 'Rmd'
-            }
-        };
-    }
-};
-const RTagRegex = /{[rR](?:[\s,][^}]*)?}/;
-/**
- * Checks whether a CommonMark node is an R code block
- */
-function isRCodeBlock(node) {
-    return node.type === 'code_block' && node.literal !== null && node.info !== null && RTagRegex.test(node.info);
-}
-const LineRegex = /\r\n|\r|\n/;
-function countNewlines(str) {
-    return str.split(LineRegex).length - 1;
-}
-/**
- * Restores an Rmd file from code blocks, filling non-code lines with empty lines
- */
-function restoreBlocksWithoutMd(blocks, totalLines) {
-    let line = 1;
-    let output = '';
-    const goToLine = (n) => {
-        const diff = n - line;
-        (0, assert_1.guard)(diff >= 0);
-        line += diff;
-        output += '\n'.repeat(diff);
-    };
-    for (const block of blocks) {
-        goToLine(block.startpos.line);
-        output += block.code;
-        line += countNewlines(block.code);
-    }
-    // Add remainder of file
-    goToLine(totalLines + 1);
-    return output;
-}
-/**
- * Parses the options of an R code block from its header and content
- */
-function parseCodeBlockOptions(header, content) {
-    let opts = header.length === 3 // '{r}' => header.length=3 (no options in header)
-        ? ''
-        : header.substring(3, header.length - 1).trim();
-    const lines = content.split('\n');
-    for (const line of lines) {
-        if (!line.trim().startsWith('#|')) {
-            break;
-        }
-        const opt = line.substring(3);
-        opts += opts.length === 0 ? opt : `, ${opt}`;
-    }
-    return opts;
-}
-//# sourceMappingURL=rmd-adapter.js.map