text-runner-engine 7.1.0

package/dist/run/name-refiner.js

@@ -0,0 +1,20 @@
+/** allows refining the current name of a test step */
+export class NameRefiner {
+    // eslint-disable-next-line no-empty-function
+    constructor(name) {
+        this.name = name;
+    }
+    /** returns the refined name */
+    finalName() {
+        return this.name;
+    }
+    /** returns a function that can be called to refine the name */
+    refineFn() {
+        return this.refineName.bind(this);
+    }
+    /** updates the currently stored name to the given name */
+    refineName(newName) {
+        this.name = newName;
+    }
+}
+//# sourceMappingURL=name-refiner.js.map

package/dist/run/output-collector.d.ts

@@ -0,0 +1,13 @@
+import * as run from "./index.js";
+/** simulates console.log to collect output from a running action */
+export declare class OutputCollector {
+    /** collects the received output */
+    content: string[];
+    /** appends to the output with a newline */
+    log(...args: any[]): void;
+    /** returns the "log" function to be used by actions */
+    logFn(): run.LogFn;
+    /** returns the currently accumulated output */
+    toString(): string;
+}
+//# sourceMappingURL=output-collector.d.ts.map

package/dist/run/output-collector.js

@@ -0,0 +1,30 @@
+import * as util from "util";
+/** simulates console.log to collect output from a running action */
+export class OutputCollector {
+    constructor() {
+        /** collects the received output */
+        this.content = [];
+    }
+    /** appends to the output with a newline */
+    log(...args) {
+        const stringified = [];
+        for (const arg of args) {
+            if (typeof arg === "string") {
+                stringified.push(arg);
+            }
+            else {
+                stringified.push(util.inspect(arg, false, Infinity));
+            }
+        }
+        this.content.push(stringified.join(" ") + "\n");
+    }
+    /** returns the "log" function to be used by actions */
+    logFn() {
+        return this.log.bind(this);
+    }
+    /** returns the currently accumulated output */
+    toString() {
+        return this.content.join("");
+    }
+}
+//# sourceMappingURL=output-collector.js.map

package/dist/run/parallel.d.ts

@@ -0,0 +1,11 @@
+import * as actions from "../actions/index.js";
+import * as activities from "../activities/index.js";
+import * as commands from "../commands/index.js";
+import * as configuration from "../configuration/index.js";
+import * as linkTargets from "../link-targets/index.js";
+/**
+ * Executes the given activities in parallel.
+ * Returns the errors they produce.
+ */
+export declare function parallel(activities: activities.List, actionFinder: actions.Finder, targets: linkTargets.List, configuration: configuration.Data, emitter: commands.Command): Promise<boolean>[];
+//# sourceMappingURL=parallel.d.ts.map

package/dist/run/parallel.js

@@ -0,0 +1,13 @@
+import { runActivity } from "./run-activity.js";
+/**
+ * Executes the given activities in parallel.
+ * Returns the errors they produce.
+ */
+export function parallel(activities, actionFinder, targets, configuration, emitter) {
+    const result = [];
+    for (const activity of activities) {
+        result.push(runActivity(activity, actionFinder, configuration, targets, emitter));
+    }
+    return result;
+}
+//# sourceMappingURL=parallel.js.map

package/dist/run/run-activity.d.ts

@@ -0,0 +1,8 @@
+import * as actions from "../actions/index.js";
+import { Activity } from "../activities/index.js";
+import * as commands from "../commands/index.js";
+import * as configuration from "../configuration/index.js";
+import * as linkTargets from "../link-targets/index.js";
+/** runs the given activity, indicates whether it encountered an error */
+export declare function runActivity(activity: Activity, actionFinder: actions.Finder, configuration: configuration.Data, targets: linkTargets.List, emitter: commands.Command): Promise<boolean>;
+//# sourceMappingURL=run-activity.d.ts.map

package/dist/run/run-activity.js

@@ -0,0 +1,76 @@
+import humanize from "humanize-string";
+import * as util from "util";
+import { isUserError, UserError } from "../errors/user-error.js";
+import { errorMessage } from "../text-runner.js";
+import { NameRefiner } from "./name-refiner.js";
+import { OutputCollector } from "./output-collector.js";
+/** runs the given activity, indicates whether it encountered an error */
+export async function runActivity(activity, actionFinder, configuration, targets, emitter) {
+    const outputCollector = new OutputCollector();
+    const nameRefiner = new NameRefiner(humanize(activity.actionName));
+    const args = {
+        configuration,
+        document: activity.document,
+        linkTargets: targets,
+        location: activity.location,
+        log: outputCollector.logFn(),
+        name: nameRefiner.refineFn(),
+        region: activity.region,
+        SKIPPING: 254
+    };
+    try {
+        const action = await actionFinder.actionFor(activity);
+        let actionResult;
+        if (action.length === 1) {
+            actionResult = await runSyncOrPromiseFunc(action, args);
+        }
+        else {
+            actionResult = await runCallbackFunc(action, args);
+        }
+        if (actionResult === undefined) {
+            emitter.emit("result", {
+                activity,
+                finalName: nameRefiner.finalName(),
+                output: outputCollector.toString(),
+                status: "success"
+            });
+        }
+        else if (actionResult === args.SKIPPING) {
+            if (configuration.showSkipped) {
+                emitter.emit("result", {
+                    activity,
+                    finalName: nameRefiner.finalName(),
+                    output: outputCollector.toString(),
+                    status: "skipped"
+                });
+            }
+        }
+        else {
+            throw new Error(`unknown return code from action: ${actionResult}`);
+        }
+    }
+    catch (e) {
+        let guidance = "";
+        if (isUserError(e)) {
+            guidance = e.guidance;
+        }
+        emitter.emit("result", {
+            activity,
+            error: new UserError(errorMessage(e), guidance, activity.location),
+            finalName: nameRefiner.finalName(),
+            output: outputCollector.toString(),
+            status: "failed"
+        });
+        return true;
+    }
+    return false;
+}
+async function runCallbackFunc(func, args) {
+    const promisified = util.promisify(func);
+    return promisified(args);
+}
+async function runSyncOrPromiseFunc(func, args) {
+    const result = await Promise.resolve(func(args));
+    return result;
+}
+//# sourceMappingURL=run-activity.js.map

package/dist/run/sequential.d.ts

@@ -0,0 +1,7 @@
+import * as actions from "../actions/index.js";
+import * as activities from "../activities/index.js";
+import * as commands from "../commands/index.js";
+import * as configuration from "../configuration/index.js";
+import * as linkTargets from "../link-targets/index.js";
+export declare function sequential(activities: activities.List, actionFinder: actions.Finder, configuration: configuration.Data, linkTargets: linkTargets.List, emitter: commands.Command): Promise<void>;
+//# sourceMappingURL=sequential.d.ts.map

package/dist/run/sequential.js

@@ -0,0 +1,10 @@
+import { runActivity } from "./run-activity.js";
+export async function sequential(activities, actionFinder, configuration, linkTargets, emitter) {
+    for (const activity of activities) {
+        const abort = await runActivity(activity, actionFinder, configuration, linkTargets, emitter);
+        if (abort) {
+            return;
+        }
+    }
+}
+//# sourceMappingURL=sequential.js.map

package/dist/run/stopwatch.d.ts

@@ -0,0 +1,12 @@
+/** StopWatch allows to measure the difference between time periods */
+export declare class StopWatch {
+    /** the time when this StopWatch was started */
+    private startTime;
+    constructor();
+    /**
+     * Duration returns a human-readable description of the difference
+     * between the current time and when this StopWatch was created.
+     */
+    duration(): string;
+}
+//# sourceMappingURL=stopwatch.d.ts.map

package/dist/run/stopwatch.js

@@ -0,0 +1,19 @@
+/** StopWatch allows to measure the difference between time periods */
+export class StopWatch {
+    constructor() {
+        this.startTime = new Date().getTime();
+    }
+    /**
+     * Duration returns a human-readable description of the difference
+     * between the current time and when this StopWatch was created.
+     */
+    duration() {
+        const endTime = new Date().getTime();
+        const milliseconds = endTime - this.startTime;
+        if (milliseconds > 1000) {
+            return `${Math.round(milliseconds / 1000)}s`;
+        }
+        return `${milliseconds}ms`;
+    }
+}
+//# sourceMappingURL=stopwatch.js.map

package/dist/text-runner.d.ts

@@ -0,0 +1,15 @@
+export * as exports from "./actions/export.js";
+export * as actions from "./actions/index.js";
+export * as activities from "./activities/index.js";
+export * as ast from "./ast/index.js";
+export * as commands from "./commands/index.js";
+export * as configuration from "./configuration/index.js";
+export { errorMessage } from "./errors/error.js";
+export { isFsError } from "./errors/node-error.js";
+export { isUserError, UserError } from "./errors/user-error.js";
+export * as events from "./events/index.js";
+export * as files from "./filesystem/index.js";
+export * as helpers from "./helpers/index.js";
+export * as parsers from "./parsers/index.js";
+export { ActivityCollector, ActivityResults } from "./run/activity-collector.js";
+//# sourceMappingURL=text-runner.d.ts.map

package/dist/text-runner.js

@@ -0,0 +1,15 @@
+export * as exports from "./actions/export.js";
+export * as actions from "./actions/index.js";
+export * as activities from "./activities/index.js";
+export * as ast from "./ast/index.js";
+export * as commands from "./commands/index.js";
+export * as configuration from "./configuration/index.js";
+export { errorMessage } from "./errors/error.js";
+export { isFsError } from "./errors/node-error.js";
+export { isUserError, UserError } from "./errors/user-error.js";
+export * as events from "./events/index.js";
+export * as files from "./filesystem/index.js";
+export * as helpers from "./helpers/index.js";
+export * as parsers from "./parsers/index.js";
+export { ActivityCollector, ActivityResults } from "./run/activity-collector.js";
+//# sourceMappingURL=text-runner.js.map

package/dist/workspace/create.d.ts

@@ -0,0 +1,4 @@
+import * as configuration from "../configuration/index.js";
+/** creates the temp directory to run the tests in */
+export declare function create(config: configuration.Data): Promise<void>;
+//# sourceMappingURL=create.d.ts.map

package/dist/workspace/create.js

@@ -0,0 +1,10 @@
+import { promises as fs } from "fs";
+/** creates the temp directory to run the tests in */
+export async function create(config) {
+    const path = config.workspace.platformified();
+    if (config.emptyWorkspace) {
+        await fs.rm(path, { force: true, recursive: true });
+    }
+    await fs.mkdir(path, { recursive: true });
+}
+//# sourceMappingURL=create.js.map

package/dist/workspace/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./create.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/workspace/index.js

@@ -0,0 +1,2 @@
+export * from "./create.js";
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "text-runner-engine",
+  "version": "7.1.0",
+  "description": "Tests documentation written in MarkDown",
+  "homepage": "https://github.com/kevgo/text-runner",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kevgo/text-runner.git"
+  },
+  "license": "ISC",
+  "author": "Kevin Goslar",
+  "type": "module",
+  "exports": "./dist/text-runner.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig-build.json",
+    "clean": "rm -rf dist",
+    "doc": "text-runner",
+    "fix": "eslint --fix --ignore-pattern=dist/ . && dprint fmt && sort-package-json --quiet",
+    "lint": "eslint --ignore-pattern=dist/ . && dprint check && sort-package-json --check --quiet && depcheck",
+    "stats": "find . -type f | grep -v /node_modules/ | grep -v /dist/ | grep -v \\./\\.git/ | grep -v \\./\\.vscode/ | grep -v \\./tmp/ | xargs scc",
+    "unit": "node --test --import tsx 'src/**/*.test.ts'"
+  },
+  "dependencies": {
+    "@sindresorhus/slugify": "2.2.1",
+    "anchor-markdown-header": "0.7.0",
+    "globby": "14.1.0",
+    "got": "14.4.6",
+    "humanize-string": "3.0.0",
+    "is-glob": "4.0.3",
+    "markdown-it": "14.1.0",
+    "parse5": "7.2.1",
+    "tmp-promise": "3.0.3"
+  },
+  "devDependencies": {
+    "@types/got": "9.6.12",
+    "@types/is-glob": "4.0.4",
+    "@types/markdown-it": "14.1.2",
+    "tsx": "4.19.3"
+  },
+  "gitHead": "bdf119a8e549f679af14f88952f7353648b50759"
+}