textrun-shell 0.1.2 → 0.2.0

package/README.md

@@ -16,7 +16,7 @@ You can define the absolute path of documented binaries in a
 an example:
 
 ```js
-module.exports = {
+export default {
   binaries: {
     "text-run": path.join(__dirname, "node_modules", ".bin", "text-run"),
   },
@@ -26,7 +26,7 @@ module.exports = {
 ### Run shell commands
 
 The <b type="action/name-full">shell/command</b> action runs a shell command and
-waits until it finishes. As an example, here is a little hypothetical Bash
+waits until it finishes. As an example, here is a little hypothetical Shell
 tutorial:
 
 > The "echo" command prints text on the command line. For example, let's run:
@@ -41,7 +41,7 @@ tutorial:
 > Hello world!
 > ```
 
-The source code of this Bash tutorial when executed and verified by Text-Runner
+The source code of this Shell tutorial when executed and verified by Text-Runner
 looks like this:
 
 <a type="extension/runnable-region">
@@ -77,7 +77,7 @@ As an example, let's say we have a command-line tool written in JavaScript
 called **greeter.js**:
 
 ```js
-const readline = require("readline")
+import * as readline from "readline"
 var rl = readline.createInterface({
   input: process.stdin,
   output: process.stdout,

package/dist/actions/command-output.js

@@ -1,17 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandOutput = void 0;
-const assertNoDiff = require("assert-no-diff");
-const current_command_1 = require("../helpers/current-command");
-const stripAnsi = require("strip-ansi");
-function commandOutput(action) {
+import * as assertNoDiff from "assert-no-diff";
+import stripAnsi from "strip-ansi";
+import { CurrentCommand } from "../helpers/current-command.js";
+export function commandOutput(action) {
     action.name("verifying the output of the last run console command");
     const expectedText = action.region.text();
     const expectedLines = expectedText
         .split("\n")
         .map((line) => line.trim())
         .filter((line) => line);
-    const actualOutput = stripAnsi(current_command_1.CurrentCommand.instance().combinedText);
+    const actualOutput = stripAnsi(CurrentCommand.instance().combinedText);
     const actualLines = actualOutput
         .split("\n")
         .map(line => line.trim())
@@ -22,5 +19,4 @@ function commandOutput(action) {
     }
     assertNoDiff.trimmedLines(expectedLines.join("\n"), commonLines.join("\n"));
 }
-exports.commandOutput = commandOutput;
 //# sourceMappingURL=command-output.js.map

package/dist/actions/command-with-input.js

@@ -1,22 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandWithInput = void 0;
-const color = require("colorette");
-const observableProcess = require("observable-process");
-const textrun_extension_1 = require("textrun-extension");
-const current_command_1 = require("../helpers/current-command");
-const trim_dollar_1 = require("../helpers/trim-dollar");
+import * as color from "colorette";
+import * as observableProcess from "observable-process";
+import { callArgs } from "textrun-extension";
+import { CurrentCommand } from "../helpers/current-command.js";
+import { trimDollar } from "../helpers/trim-dollar.js";
 /**
  * The "runConsoleCommand" action runs the given commands on the console
  * and waits until the command is finished.
  */
-async function commandWithInput(action) {
+export async function commandWithInput(action) {
     const content = action.region.textInNodeOfTypes("fence", "code");
     const commandsToRun = content
         .split("\n")
         .map((command) => command.trim())
         .filter((e) => e)
-        .map(trim_dollar_1.trimDollar)
+        .map(trimDollar)
         .join(" && ");
     if (commandsToRun === "") {
         throw new Error(`the <${action.region[0].tag} ${action.configuration.regionMarker}="exec-with-input"> region contains no commands to run`);
@@ -27,17 +24,16 @@ async function commandWithInput(action) {
         input = getInput(action.region);
     }
     // this needs to be global because it is used in the "verify-run-console-output" step
-    const processor = observableProcess.start((0, textrun_extension_1.callArgs)(commandsToRun, process.platform), {
+    const processor = observableProcess.start(callArgs(commandsToRun, process.platform), {
         cwd: action.configuration.workspace.platformified(),
     });
     for (const inputLine of input) {
         await enter(processor, inputLine);
     }
     const finished = (await processor.waitForEnd());
-    current_command_1.CurrentCommand.set(finished);
+    CurrentCommand.set(finished);
     action.log(processor.output.fullText());
 }
-exports.commandWithInput = commandWithInput;
 async function enter(processor, input) {
     processor.stdin.write(input.input + "\n");
     if (input.textToWait) {

package/dist/actions/command.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const color = require("colorette");
-const observableProcess = require("observable-process");
-const trExt = require("textrun-extension");
-const configuration_1 = require("../helpers/configuration");
-const current_command_1 = require("../helpers/current-command");
-const trim_dollar_1 = require("../helpers/trim-dollar");
+import * as color from "colorette";
+import * as observableProcess from "observable-process";
+import * as trExt from "textrun-extension";
+import { Configuration } from "../helpers/configuration.js";
+import { CurrentCommand } from "../helpers/current-command.js";
+import { trimDollar } from "../helpers/trim-dollar.js";
 /** Runs the given commands synchronously on the console. */
-async function command(action) {
-    const config = await configuration_1.Configuration.load(action.configuration.sourceDir.joinStr("textrun-shell.js"));
+export async function command(action) {
+    const configPath = action.configuration.sourceDir.joinStr("textrun-shell.js");
+    const config = await Configuration.load(configPath);
     const commandsToRun = action.region
         .text()
         .split("\n")
         .map((line) => line.trim())
-        .map(trim_dollar_1.trimDollar)
+        .map(trimDollar)
         .filter((line) => line.length > 0)
         .map(config.pathMapper().globalizePathFunc())
         .join(" && ");
@@ -28,10 +26,9 @@ async function command(action) {
     // this is also used in the "verify-run-console-output" step
     const finished = (await processor.waitForEnd());
     action.log(finished.combinedText);
-    current_command_1.CurrentCommand.set(finished);
+    CurrentCommand.set(finished);
     if (finished.exitCode !== 0) {
         throw new Error(`command "${commandsToRun}" failed with exit code ${finished.exitCode}`);
     }
 }
-exports.command = command;
 //# sourceMappingURL=command.js.map

package/dist/actions/server-output.js

@@ -1,19 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serverOutput = void 0;
-const current_server_1 = require("../helpers/current-server");
+import { CurrentServer } from "../helpers/current-server.js";
 /**
  * The "start-output" action waits until the currently running console command
  * produces the given output.
  */
-async function serverOutput(action) {
+export async function serverOutput(action) {
     action.name("verifying the output of the long-running process");
     const expectedOutput = action.region.textInNodeOfType("fence");
     const expectedLines = expectedOutput
         .split("\n")
         .map((line) => line.trim())
         .filter((line) => line);
-    const process = current_server_1.CurrentServer.instance().process;
+    const process = CurrentServer.instance().process;
     if (!process) {
         throw new Error("Cannot verify process output since no process has been started");
     }
@@ -23,5 +20,4 @@ async function serverOutput(action) {
     }
     action.log(process.output.fullText());
 }
-exports.serverOutput = serverOutput;
 //# sourceMappingURL=server-output.js.map

package/dist/actions/server.js

@@ -1,27 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.server = void 0;
-const color = require("colorette");
-const observableProcess = require("observable-process");
-const trExt = require("textrun-extension");
-const current_server_1 = require("../helpers/current-server");
-const trim_dollar_1 = require("../helpers/trim-dollar");
+import * as color from "colorette";
+import * as observableProcess from "observable-process";
+import * as trExt from "textrun-extension";
+import { CurrentServer } from "../helpers/current-server.js";
+import { trimDollar } from "../helpers/trim-dollar.js";
 /**
  * The "start" action runs the given commands on the console.
  * It leaves the command running.
  */
-function server(action) {
+export function server(action) {
     const commandsToRun = action.region
         .text()
         .split("\n")
         .map((line) => line.trim())
         .filter((line) => line.length > 0)
-        .map(trim_dollar_1.trimDollar)
+        .map(trimDollar)
         .join(" && ");
     action.name(`starting a server process: ${color.bold(color.cyan(commandsToRun))}`);
-    current_server_1.CurrentServer.instance().set(observableProcess.start(trExt.callArgs(commandsToRun, process.platform), {
+    CurrentServer.instance().set(observableProcess.start(trExt.callArgs(commandsToRun, process.platform), {
         cwd: action.configuration.workspace.platformified(),
     }));
 }
-exports.server = server;
 //# sourceMappingURL=server.js.map

package/dist/actions/stop-server.js

@@ -1,20 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopServer = void 0;
-const end_child_processes_1 = require("end-child-processes");
-const current_server_1 = require("../helpers/current-server");
+import { endChildProcesses } from "end-child-processes";
+import { CurrentServer } from "../helpers/current-server.js";
 /**
  * The "stop" action stops the currently running server process,
  * started by the "start" action.
  */
-async function stopServer(action) {
+export async function stopServer(action) {
     action.name("stopping the long-running process");
-    if (!current_server_1.CurrentServer.instance().hasProcess()) {
+    if (!CurrentServer.instance().hasProcess()) {
         throw new Error("No running process found");
     }
-    await current_server_1.CurrentServer.instance().kill();
-    await (0, end_child_processes_1.endChildProcesses)();
-    current_server_1.CurrentServer.instance().reset();
+    await CurrentServer.instance().kill();
+    await endChildProcesses();
+    CurrentServer.instance().reset();
 }
-exports.stopServer = stopServer;
 //# sourceMappingURL=stop-server.js.map

package/dist/helpers/configuration.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
-const path_mapper_1 = require("./path-mapper");
+import { PathMapper } from "./path-mapper.js";
 /** Configuration represents the configuration options for the textrun-shell library. */
-class Configuration {
+export class Configuration {
     constructor(file) {
         this.file = file;
     }
@@ -15,8 +12,9 @@ class Configuration {
     /** Provides the configuration stored in the file with the given path. */
     static async load(filePath) {
         try {
-            const content = await Promise.resolve().then(() => require(filePath));
-            return new Configuration(content);
+            const content = await import(filePath);
+            const config = content.default;
+            return new Configuration(config);
         }
         catch (e) {
             return Configuration.default();
@@ -24,8 +22,7 @@ class Configuration {
     }
     /** provides the PathMapper instance to use */
     pathMapper() {
-        return new path_mapper_1.PathMapper(this.file.globals);
+        return new PathMapper(this.file.globals);
     }
 }
-exports.Configuration = Configuration;
 //# sourceMappingURL=configuration.js.map

package/dist/helpers/current-command.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrentCommand = void 0;
 /** CurrentCommand provides global access to the currently running console command. */
-class CurrentCommand {
+export class CurrentCommand {
     static instance() {
         if (!instance) {
             throw new Error("no instance");
@@ -13,6 +10,5 @@ class CurrentCommand {
         instance = process;
     }
 }
-exports.CurrentCommand = CurrentCommand;
 let instance = null;
 //# sourceMappingURL=current-command.js.map

package/dist/helpers/current-server.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrentServer = void 0;
 /** CurrentServer provides global access to the currently running server process. */
-class CurrentServer {
+export class CurrentServer {
     constructor() {
         this.process = null;
     }
@@ -23,6 +20,5 @@ class CurrentServer {
         this.process = process;
     }
 }
-exports.CurrentServer = CurrentServer;
 const instance = new CurrentServer();
 //# sourceMappingURL=current-server.js.map

package/dist/helpers/path-mapper.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathMapper = void 0;
 /** Absolutifier makes  */
-class PathMapper {
+export class PathMapper {
     constructor(mappings) {
         this.mappings = mappings;
     }
@@ -20,5 +17,4 @@ class PathMapper {
         return words.join(" ");
     }
 }
-exports.PathMapper = PathMapper;
 //# sourceMappingURL=path-mapper.js.map

package/dist/helpers/trim-dollar.js

@@ -1,9 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trimDollar = void 0;
 /** trims the leading dollar from the given command */
-function trimDollar(text) {
+export function trimDollar(text) {
     return text.replace(/^\$?\s*/, "");
 }
-exports.trimDollar = trimDollar;
 //# sourceMappingURL=trim-dollar.js.map

package/dist/index.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.textrunActions = void 0;
-const command_1 = require("./actions/command");
-const command_output_1 = require("./actions/command-output");
-const command_with_input_1 = require("./actions/command-with-input");
-const server_1 = require("./actions/server");
-const server_output_1 = require("./actions/server-output");
-const stop_server_1 = require("./actions/stop-server");
-exports.textrunActions = {
-    command: command_1.command,
-    commandOutput: command_output_1.commandOutput,
-    commandWithInput: command_with_input_1.commandWithInput,
-    serverOutput: server_output_1.serverOutput,
-    server: server_1.server,
-    stopServer: stop_server_1.stopServer,
+import { command } from "./actions/command.js";
+import { commandOutput } from "./actions/command-output.js";
+import { commandWithInput } from "./actions/command-with-input.js";
+import { server } from "./actions/server.js";
+import { serverOutput } from "./actions/server-output.js";
+import { stopServer } from "./actions/stop-server.js";
+export const textrunActions = {
+    command,
+    commandOutput,
+    commandWithInput,
+    serverOutput,
+    server,
+    stopServer,
 };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,26 +1,37 @@
 {
   "name": "textrun-shell",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "license": "ISC",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
   "files": [
     "dist/**/*.js"
   ],
+  "scripts": {
+    "build": "tsc -p tsconfig-build.json",
+    "clean": "rm -rf dist",
+    "cuke": "cucumber-js --format=progress",
+    "doc": "text-run static --format=summary && text-run dynamic --format=progress",
+    "fix": "eslint . --fix --ext=.ts --ignore-path=../.eslintignore && prettier --write .",
+    "lint": "prettier -l . && eslint . --ext=.ts --ignore-path=../.eslintignore && depcheck --config=../.depcheckrc",
+    "unit": "env NODE_NO_WARNINGS=1 mocha --reporter=dot 'src/**/*.test.ts'"
+  },
   "dependencies": {
     "assert-no-diff": "3.0.6",
     "colorette": "2.0.19",
     "end-child-processes": "1.0.3",
     "observable-process": "8.0.0-pre4",
-    "strip-ansi": "6.0.0",
-    "text-runner-core": "^5.0.2",
-    "textrun-extension": "^0.1.2"
+    "strip-ansi": "7.0.1",
+    "text-runner-core": "6.0.0",
+    "textrun-extension": "0.2.0"
   },
   "devDependencies": {
-    "shared-cucumber-steps": "0.0.0",
-    "text-runner": "^5.0.2",
-    "textrun-action": "^0.1.2",
-    "textrun-extension": "0.1.2",
-    "textrun-workspace": "^0.1.2"
+    "shared-cucumber-steps": "*",
+    "text-runner": "6.0.0",
+    "textrun-action": "0.2.0",
+    "textrun-extension": "0.2.0",
+    "textrun-workspace": "0.2.0",
+    "ts-node": "10.9.1"
   },
-  "gitHead": "1dca29620ef3189c64a62d706ded97c9b99deda3"
+  "gitHead": "5434976346f2e02bc08c0a6ea9f7cbfa67d68c4e"
 }