@eagleoutice/flowr 2.6.1 → 2.6.2

package/util/files.d.ts

@@ -1,4 +1,4 @@
-import type { PathLike } from 'fs';
+import { type PathLike } from 'fs';
 import type { RParseRequestFromFile } from '../r-bridge/retriever';
 import type { FlowrFileProvider } from '../project/context/flowr-file';
 /**
@@ -13,45 +13,43 @@ export interface Table {
  * @param dir    - Directory path to start the search from
  * @param suffix - Suffix of the files to be retrieved
  * Based on {@link https://stackoverflow.com/a/45130990}
- *
  * @see {@link getAllFilesSync} for a synchronous version.
  */
 export declare function getAllFiles(dir: string, suffix?: RegExp): AsyncGenerator<string>;
 /**
  * Retrieves all files in the given directory recursively (synchronously)
- *
  * @see {@link getAllFiles} - for an asynchronous version.
  */
 export declare function getAllFilesSync(dir: string, suffix?: RegExp): Generator<string>;
 /**
  * Retrieves all R files in a given directory (asynchronously)
- *
- *
  * @param input - directory-path to start the search from, can be a file as well. Will just return the file then.
  * @param limit - limit the number of files to be retrieved
- *
  * @returns Number of files processed (normally &le; `limit`, is &ge; `limit` if limit was reached).
  *          Will be `1`, if `input` is an R file (and `0` if it isn't).
- *
  * @see getAllFiles
  */
 export declare function allRFiles(input: string, limit?: number): AsyncGenerator<RParseRequestFromFile, number>;
 /**
  * Retrieves all R files in a given set of directories and files (asynchronously)
- *
  * @param inputs - Files or directories to validate for R-files
  * @param limit  - Limit the number of files to be retrieved
  * @returns Number of files processed (&le; limit)
- *
  * @see allRFiles
  */
 export declare function allRFilesFrom(inputs: string[], limit?: number): AsyncGenerator<RParseRequestFromFile, number>;
+/**
+ * Writes the given table as a CSV file.
+ * @param table   - The table to write
+ * @param file    - The file path to write the CSV to
+ * @param sep     - The separator to use (default: `,`)
+ * @param newline - The newline character to use (default: `\n`)
+ */
 export declare function writeTableAsCsv(table: Table, file: string, sep?: string, newline?: string): void;
 /**
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
  * The `maxLines` option limits the maximum number of read lines and is `Infinity` by default.
- *
  * @returns Whether all lines have been successfully read (`false` if `maxLines` was reached)
  *
  * See {@link readLineByLineSync} for a synchronous version.
@@ -61,7 +59,6 @@ export declare function readLineByLine(filePath: string, onLine: (line: Buffer,
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
  * The `maxLines` option limits the maximum number of read lines and is `Infinity` by default.
- *
  * @returns Whether the file exists and all lines have been successfully read (`false` if `maxLines` was reached)
  *
  * See {@link readLineByLine} for an asynchronous version.
@@ -79,4 +76,7 @@ export declare function getParentDirectory(directory: string): string;
  * @returns Map containing the keys and values of the provided file.
  */
 export declare function parseDCF(file: FlowrFileProvider<string>): Map<string, string[]>;
+/**
+ * Checks whether the given path-like object is a file that exists on the local filesystem.
+ */
 export declare function isFilePath(p: PathLike): boolean;

package/util/files.js

@@ -55,7 +55,6 @@ const n_readlines_1 = __importDefault(require("n-readlines"));
  * @param dir    - Directory path to start the search from
  * @param suffix - Suffix of the files to be retrieved
  * Based on {@link https://stackoverflow.com/a/45130990}
- *
  * @see {@link getAllFilesSync} for a synchronous version.
  */
 async function* getAllFiles(dir, suffix = /.*/) {
@@ -72,7 +71,6 @@ async function* getAllFiles(dir, suffix = /.*/) {
 }
 /**
  * Retrieves all files in the given directory recursively (synchronously)
- *
  * @see {@link getAllFiles} - for an asynchronous version.
  */
 function* getAllFilesSync(dir, suffix = /.*/) {
@@ -90,14 +88,10 @@ function* getAllFilesSync(dir, suffix = /.*/) {
 const rFileRegex = /\.[rR]$/;
 /**
  * Retrieves all R files in a given directory (asynchronously)
- *
- *
  * @param input - directory-path to start the search from, can be a file as well. Will just return the file then.
  * @param limit - limit the number of files to be retrieved
- *
  * @returns Number of files processed (normally ≤ `limit`, is ≥ `limit` if limit was reached).
  *          Will be `1`, if `input` is an R file (and `0` if it isn't).
- *
  * @see getAllFiles
  */
 async function* allRFiles(input, limit = Number.MAX_VALUE) {
@@ -120,11 +114,9 @@ async function* allRFiles(input, limit = Number.MAX_VALUE) {
 }
 /**
  * Retrieves all R files in a given set of directories and files (asynchronously)
- *
  * @param inputs - Files or directories to validate for R-files
  * @param limit  - Limit the number of files to be retrieved
  * @returns Number of files processed (≤ limit)
- *
  * @see allRFiles
  */
 async function* allRFilesFrom(inputs, limit) {
@@ -139,6 +131,13 @@ async function* allRFilesFrom(inputs, limit) {
     }
     return count;
 }
+/**
+ * Writes the given table as a CSV file.
+ * @param table   - The table to write
+ * @param file    - The file path to write the CSV to
+ * @param sep     - The separator to use (default: `,`)
+ * @param newline - The newline character to use (default: `\n`)
+ */
 function writeTableAsCsv(table, file, sep = ',', newline = '\n') {
     const csv = [table.header.join(sep), ...table.rows.map(row => row.join(sep))].join(newline);
     fs_1.default.writeFileSync(file, csv);
@@ -147,7 +146,6 @@ function writeTableAsCsv(table, file, sep = ',', newline = '\n') {
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
  * The `maxLines` option limits the maximum number of read lines and is `Infinity` by default.
- *
  * @returns Whether all lines have been successfully read (`false` if `maxLines` was reached)
  *
  * See {@link readLineByLineSync} for a synchronous version.
@@ -173,7 +171,6 @@ async function readLineByLine(filePath, onLine, maxLines = Infinity) {
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
  * The `maxLines` option limits the maximum number of read lines and is `Infinity` by default.
- *
  * @returns Whether the file exists and all lines have been successfully read (`false` if `maxLines` was reached)
  *
  * See {@link readLineByLine} for an asynchronous version.
@@ -244,6 +241,9 @@ function cleanValues(values) {
         .map(s => s.trim().replace(cleanQuotesRegex, ''))
         .filter(s => s.length > 0);
 }
+/**
+ * Checks whether the given path-like object is a file that exists on the local filesystem.
+ */
 function isFilePath(p) {
     return fs_1.default.existsSync(p) && fs_1.default.statSync(p).isFile();
 }

package/util/formats/adapter.d.ts

@@ -13,6 +13,15 @@ export declare const DocumentTypeToFormat: {
     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

@@ -18,6 +18,9 @@ exports.DocumentTypeToFormat = {
     '.r': 'R',
     '.rmd': 'Rmd'
 };
+/**
+ * Produce a parse request from a file path
+ */
 function requestFromFile(path) {
     const baseRequest = {
         request: 'file',
@@ -26,6 +29,9 @@ function requestFromFile(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',
@@ -35,6 +41,9 @@ function requestFromText(text, typeHint) {
     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';

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

@@ -1,4 +1,4 @@
-import type { Node } from 'commonmark';
+import { type Node } from 'commonmark';
 import type { RParseRequest, RParseRequestFromText } from '../../../r-bridge/retriever';
 export interface CodeBlock {
     options: string;
@@ -18,9 +18,18 @@ export interface RmdInfo {
 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

@@ -49,6 +49,9 @@ exports.RmdAdapter = {
     }
 };
 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);
 }
@@ -56,6 +59,9 @@ 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 = '';
@@ -70,10 +76,13 @@ function restoreBlocksWithoutMd(blocks, totalLines) {
         output += block.code;
         line += countNewlines(block.code);
     }
-    // Add remainder of file 
+    // 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)
         ? ''

package/util/html-hover-over.d.ts

@@ -1 +1,6 @@
+/**
+ * Wraps the given text in a span with a tooltip if the tooltip is provided.
+ * @param text    - The text to wrap
+ * @param tooltip - The tooltip to add
+ */
 export declare function textWithTooltip(text: string, tooltip?: string): string;

package/util/html-hover-over.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.textWithTooltip = textWithTooltip;
+/**
+ * Wraps the given text in a span with a tooltip if the tooltip is provided.
+ * @param text    - The text to wrap
+ * @param tooltip - The tooltip to add
+ */
 function textWithTooltip(text, tooltip) {
     return tooltip ? `<span title=${JSON.stringify(tooltip)}>${text}</span>` : text;
 }

package/util/json.d.ts

@@ -1,3 +1,16 @@
+/**
+ * This is flowR's custom JSON replacer, used to stringify flowR-internal structures.
+ * @see {@link jsonBigIntRetriever}
+ * @see {@link superBigJsonStringify}
+ */
 export declare function jsonReplacer(key: unknown, value: unknown): unknown;
+/**
+ * This is flowR's custom JSON retriever, used to parse flowR-internal structures.
+ * @see {@link jsonReplacer}
+ * @see {@link superBigJsonStringify}
+ */
 export declare function jsonBigIntRetriever(key: string, value: unknown): unknown;
+/**
+ * Stringifies potentially very large objects to JSON, sending chunks to the provided send function.
+ */
 export declare function superBigJsonStringify(obj: unknown, end: string, send: (s: string) => void): void;

package/util/json.js

@@ -5,6 +5,11 @@ exports.jsonReplacer = jsonReplacer;
 exports.jsonBigIntRetriever = jsonBigIntRetriever;
 exports.superBigJsonStringify = superBigJsonStringify;
 const environment_1 = require("../dataflow/environments/environment");
+/**
+ * This is flowR's custom JSON replacer, used to stringify flowR-internal structures.
+ * @see {@link jsonBigIntRetriever}
+ * @see {@link superBigJsonStringify}
+ */
 function jsonReplacer(key, value) {
     if (key === 'fullLexeme') {
         return undefined;
@@ -19,6 +24,11 @@ function jsonReplacer(key, value) {
         return value;
     }
 }
+/**
+ * This is flowR's custom JSON retriever, used to parse flowR-internal structures.
+ * @see {@link jsonReplacer}
+ * @see {@link superBigJsonStringify}
+ */
 function jsonBigIntRetriever(key, value) {
     if (typeof value === 'string' && value.endsWith('n')) {
         return BigInt(value.slice(0, -1));
@@ -27,6 +37,9 @@ function jsonBigIntRetriever(key, value) {
         return value;
     }
 }
+/**
+ * Stringifies potentially very large objects to JSON, sending chunks to the provided send function.
+ */
 function superBigJsonStringify(obj, end, send) {
     try {
         const tryOut = JSON.stringify(obj, jsonReplacer) + end;

package/util/log.d.ts

@@ -7,8 +7,8 @@ export declare class FlowrLogger extends Logger<ILogObj> {
     getSubLogger(settings?: ISettingsParam<ILogObj>, logObj?: ILogObj): Logger<ILogObj>;
     updateSettings(updater: (logger: Logger<ILogObj>) => void): void;
     /**
-   * make the logger log to a file as well
-   */
+     * make the logger log to a file as well
+     */
     logToFile(filename?: string, options?: Options): void;
 }
 export declare const enum LogLevel {

package/util/log.js

@@ -24,8 +24,8 @@ class FlowrLogger extends tslog_1.Logger {
         });
     }
     /**
-   * make the logger log to a file as well
-   */
+     * make the logger log to a file as well
+     */
     logToFile(filename = 'flowr.log', options = {
         size: '10M',
         interval: '1d',

package/util/mermaid/ast.d.ts

@@ -1,4 +1,7 @@
 import type { RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ * Serialize the normalized AST to mermaid format
+ */
 export declare function normalizedAstToMermaid(ast: RNodeWithParent, prefix?: string): string;
 /**
  * Use mermaid to visualize the normalized AST.

package/util/mermaid/ast.js

@@ -6,6 +6,9 @@ const mermaid_1 = require("./mermaid");
 const visitor_1 = require("../../r-bridge/lang-4.x/ast/model/processing/visitor");
 const type_1 = require("../../r-bridge/lang-4.x/ast/model/type");
 const r_function_call_1 = require("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call");
+/**
+ * Serialize the normalized AST to mermaid format
+ */
 function normalizedAstToMermaid(ast, prefix = 'flowchart TD\n') {
     let output = prefix;
     function showNode(n) {

package/util/mermaid/cfg.d.ts

@@ -1,5 +1,5 @@
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { ControlFlowInformation } from '../../control-flow/control-flow-graph';
+import { type ControlFlowInformation } from '../../control-flow/control-flow-graph';
 /**
  * Convert the control flow graph to a mermaid string.
  * @param cfg              - The control flow graph to convert.

package/util/mermaid/dfg.d.ts

@@ -1,7 +1,7 @@
 import type { SourceRange } from '../range';
-import type { DataflowGraph } from '../../dataflow/graph/graph';
-import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
-import type { IdentifierDefinition } from '../../dataflow/environments/identifier';
+import { type DataflowGraph } from '../../dataflow/graph/graph';
+import { type NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { type IdentifierDefinition } from '../../dataflow/environments/identifier';
 type MarkVertex = NodeId;
 type MarkEdge = `${string}->${string}`;
 export type MermaidMarkdownMark = MarkVertex | MarkEdge;
@@ -26,6 +26,9 @@ interface MermaidGraph {
  * Prints a {@link SourceRange|range} as a human-readable string.
  */
 export declare function formatRange(range: SourceRange | undefined): string;
+/**
+ * Prints an identifier definition in a human-readable format.
+ */
 export declare function printIdentifier(id: IdentifierDefinition): string;
 interface MermaidGraphConfiguration {
     graph: DataflowGraph;
@@ -38,13 +41,15 @@ interface MermaidGraphConfiguration {
     presentEdges?: Set<string>;
     simplified?: boolean;
 }
+/**
+ * Converts a dataflow graph to mermaid graph code that visualizes the graph.
+ */
 export declare function graphToMermaid(config: MermaidGraphConfiguration): {
     string: string;
     mermaid: MermaidGraph;
 };
 /**
  * Converts a dataflow graph to a mermaid url that visualizes the graph.
- *
  * @param graph               - The graph to convert
  * @param includeEnvironments - Whether to include the environments in the mermaid graph code
  * @param mark                - Special nodes to mark (e.g., those included in the slice)
@@ -58,5 +63,8 @@ export interface LabeledDiffGraph {
 }
 /** uses same id map but ensures, it is different from the rhs so that mermaid can work with that */
 export declare function diffGraphsToMermaid(left: LabeledDiffGraph, right: LabeledDiffGraph, prefix: string): string;
+/**
+ * Converts two dataflow graphs to a mermaid url that visualizes their differences.
+ */
 export declare function diffGraphsToMermaidUrl(left: LabeledDiffGraph, right: LabeledDiffGraph, prefix: string): string;
 export {};

package/util/mermaid/dfg.js

@@ -126,6 +126,9 @@ function mermaidNodeBrackets(tag) {
     }
     return { open, close };
 }
+/**
+ * Prints an identifier definition in a human-readable format.
+ */
 function printIdentifier(id) {
     return `**${id.name}** (id: ${id.nodeId}, type: ${identifier_1.ReferenceTypeReverseMapping.get(id.type)},${id.controlDependencies ? ' cds: {' + id.controlDependencies.map(c => c.id + (c.when ? '+' : '-')).join(',') + '},' : ''} def. @${id.definedAt})`;
 }
@@ -220,13 +223,15 @@ function graphToMermaidGraph(rootIds, { simplified, graph, prefix = 'flowchart B
     }
     return mermaid;
 }
+/**
+ * Converts a dataflow graph to mermaid graph code that visualizes the graph.
+ */
 function graphToMermaid(config) {
     const mermaid = graphToMermaidGraph(config.graph.rootIds(), config);
     return { string: `${mermaid.nodeLines.join('\n')}\n${mermaid.edgeLines.join('\n')}`, mermaid };
 }
 /**
  * Converts a dataflow graph to a mermaid url that visualizes the graph.
- *
  * @param graph               - The graph to convert
  * @param includeEnvironments - Whether to include the environments in the mermaid graph code
  * @param mark                - Special nodes to mark (e.g., those included in the slice)
@@ -242,6 +247,9 @@ function diffGraphsToMermaid(left, right, prefix) {
     const { string: rightGraph } = graphToMermaid({ graph: right.graph, prefix: '', idPrefix: `r-${right.label}`, includeEnvironments: true, mark: right.mark, presentEdges: mermaid.presentEdges });
     return `${prefix}flowchart BT\nsubgraph "${left.label}"\n${leftGraph}\nend\nsubgraph "${right.label}"\n${rightGraph}\nend`;
 }
+/**
+ * Converts two dataflow graphs to a mermaid url that visualizes their differences.
+ */
 function diffGraphsToMermaidUrl(left, right, prefix) {
     return (0, mermaid_1.mermaidCodeToUrl)(diffGraphsToMermaid(left, right, prefix));
 }

package/util/mermaid/mermaid.d.ts

@@ -1,8 +1,13 @@
+/**
+ * Escapes markdown special characters in a string.
+ */
 export declare function escapeMarkdown(text: string): string;
+/**
+ * Escapes a string or number to be used as a mermaid node id.
+ */
 export declare function escapeId(text: string | number): string;
 /**
  * Converts mermaid code (potentially produced by {@link graphToMermaid}) to an url that presents the graph in the mermaid editor.
- *
  * @param code - code to convert
  * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
  */

package/util/mermaid/mermaid.js

@@ -40,19 +40,24 @@ const replacements = {
     '∫': '#8747;',
     '⊕': '#8853;',
 };
+/**
+ * Escapes markdown special characters in a string.
+ */
 function escapeMarkdown(text) {
     for (const [key, value] of Object.entries(replacements)) {
         text = text.replaceAll(key, value);
     }
     return text;
 }
+/**
+ * Escapes a string or number to be used as a mermaid node id.
+ */
 function escapeId(text) {
     text = String(text).replace(/[^a-zA-Z0-9:-]/g, '_');
     return text;
 }
 /**
  * Converts mermaid code (potentially produced by {@link graphToMermaid}) to an url that presents the graph in the mermaid editor.
- *
  * @param code - code to convert
  * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
  */

package/util/numbers.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Converts a bigint (or string representation of a bigint) to a number by removing the trailing `n`.
+ * Please note that this can lead to loss of precision for very large bigints.
+ */
 export declare function bigint2number(a: bigint | string): number;
+/**
+ * Rounds a number to the specified number of decimal places.
+ */
 export declare function roundToDecimals(value: number, decimals: number): number;

package/util/numbers.js

@@ -2,10 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bigint2number = bigint2number;
 exports.roundToDecimals = roundToDecimals;
+/**
+ * Converts a bigint (or string representation of a bigint) to a number by removing the trailing `n`.
+ * Please note that this can lead to loss of precision for very large bigints.
+ */
 function bigint2number(a) {
     // we have to remove the trailing `n`
     return Number(String(a).slice(0, -1));
 }
+/**
+ * Rounds a number to the specified number of decimal places.
+ */
 function roundToDecimals(value, decimals) {
     const factor = 10 ** decimals;
     return Math.round(value * factor) / factor;

package/util/objects.d.ts

@@ -10,7 +10,6 @@ type OrReadonly<T> = T | Readonly<T> | DeepReadonly<T>;
 /**
  * Given two objects deeply merges them, if an object is an array it will merge the array values!
  * Guarantees some type safety by requiring objects to merge to be from the same type (allows undefined)
- *
  * @see {@link deepMergeObjectInPlace} to merge into an existing object
  */
 export declare function deepMergeObject<T extends Mergeable>(base: Required<OrReadonly<T>>, addon?: T | DeepPartial<T> | Partial<T>): Required<T>;
@@ -22,7 +21,6 @@ export declare function deepMergeObject(base?: Mergeable, addon?: Mergeable): Me
  * Given two objects deeply merges them, if an object is an array it will merge the array values!
  * Modifies the `base` object in place and also returns it.
  * Guarantees some type safety by requiring objects to merge to be from the same type (allows undefined)
- *
  * @see {@link deepMergeObject} to create a new merged object
  */
 export declare function deepMergeObjectInPlace<T extends Mergeable>(base: T, addon?: DeepPartial<T> | Partial<T>): T;

package/util/os.d.ts

@@ -1,2 +1,5 @@
 export type Os = 'mac-os' | 'linux' | 'windows' | 'unknown';
+/**
+ * Returns the current operating system platform.
+ */
 export declare function getPlatform(): Os;

package/util/os.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPlatform = getPlatform;
 let platformCache = null;
+/**
+ * Returns the current operating system platform.
+ */
 function getPlatform() {
     if (platformCache !== null) {
         return platformCache;

package/util/parallel.d.ts

@@ -15,10 +15,10 @@ export declare class LimitedThreadPool {
     private reportingInterval;
     private readonly timeLimitInMs;
     /**
-   * Create a new parallel helper that runs the given `module` once for each list of {@link Arguments} in the `queue`.
-   * The `limit` stops the execution if `<limit>` number of runs exited successfully.
-   * The `parallel` parameter limits the number of parallel executions.
-   */
+     * Create a new parallel helper that runs the given `module` once for each list of {@link Arguments} in the `queue`.
+     * The `limit` stops the execution if `<limit>` number of runs exited successfully.
+     * The `parallel` parameter limits the number of parallel executions.
+     */
     constructor(module: string, queue: WorkingQueue, limit: number, parallel: number, timeLimitInMs?: number);
     run(): Promise<void>;
     getStats(): {

package/util/parallel.js

@@ -58,10 +58,10 @@ class LimitedThreadPool {
     reportingInterval = undefined;
     timeLimitInMs;
     /**
-   * Create a new parallel helper that runs the given `module` once for each list of {@link Arguments} in the `queue`.
-   * The `limit` stops the execution if `<limit>` number of runs exited successfully.
-   * The `parallel` parameter limits the number of parallel executions.
-   */
+     * Create a new parallel helper that runs the given `module` once for each list of {@link Arguments} in the `queue`.
+     * The `limit` stops the execution if `<limit>` number of runs exited successfully.
+     * The `parallel` parameter limits the number of parallel executions.
+     */
     constructor(module, queue, limit, parallel, timeLimitInMs) {
         this.workingQueue = queue;
         this.limit = limit;

package/util/prefix.d.ts

@@ -1,7 +1,6 @@
 /**
  * given a potentially partial prefix like `hell`, this finds the matching name in the map, but only
  * if it is unique!
- *
  * @example
  * ```typescript
  * findByPrefixIfUnique('hell', { 'hello', 'bar' }) // => 'hello'

package/util/prefix.js

@@ -4,7 +4,6 @@ exports.findByPrefixIfUnique = findByPrefixIfUnique;
 /**
  * given a potentially partial prefix like `hell`, this finds the matching name in the map, but only
  * if it is unique!
- *
  * @example
  * ```typescript
  * findByPrefixIfUnique('hell', { 'hello', 'bar' }) // => 'hello'