textrun-workspace 0.5.0 → 0.7.0

package/README.md

@@ -167,6 +167,46 @@ Now file _greeting/hello.txt_ has content `hello sun and moonlight`.
 
 </a>
 
+## compare-files
+
+The <code type="action/name-full">workspace/compare-files</code> action compares
+the content of the given files.
+
+Assume the workspace contains file <a type="workspace/new-file"> _one.txt_, with
+content `hello`</a>, and file <a type="workspace/new-file"> _two.txt_, also with
+content `hello`</a>. Then this documentation passes:
+
+<a type="extension/runnable-region">
+
+```html
+<a type="workspace/compare-files" have="one.txt" want="two.txt"></a>.
+```
+
+</a>
+
+## copy-file
+
+The <code type="action/name-full">workspace/copy-file</code> action copies the
+given file.
+
+Assume the workspace contains file <a type="workspace/new-file">
+_greeting/hello.txt_ with content `hello`</a>. Then you execute this
+documentation:
+
+<a type="extension/runnable-region">
+
+```html
+<a type="workspace/copy-file" src="greeting/hello.txt" dst="new.txt"></a>.
+```
+
+</a>
+
+<a type="workspace/existing-file-with-content">
+
+Now your workspace contains a new file _new.txt_ with content `hello`.
+
+</a>
+
 ## empty-file
 
 The <b type="action/name-full">workspace/empty-file</b> action creates an empty

package/dist/actions/compare-files.js

@@ -0,0 +1,43 @@
+import * as assertNoDiff from "assert-no-diff";
+import { promises as fs } from "fs";
+import { styleText } from "node:util";
+import * as textRunner from "text-runner-engine";
+export async function compareFiles(action) {
+    const have = action.region[0].attributes["have"];
+    if (!have) {
+        throw new textRunner.UserError("Missing attribute: have", 'Please provide the file to verify via the "have" attribute');
+    }
+    const want = action.region[0].attributes["want"];
+    if (!want) {
+        throw new textRunner.UserError("Missing attribute: want", 'Please provide the golden file via the "want" attribute');
+    }
+    action.name(`compare files ${styleText("cyan", have)} and ${styleText("cyan", want)}`);
+    const haveContent = await readFile(have, action.configuration.workspace);
+    const wantContent = await readFile(want, action.configuration.workspace);
+    try {
+        assertNoDiff.trimmedLines(haveContent.trim(), wantContent.trim());
+    }
+    catch (err) {
+        action.log(haveContent);
+        throw new textRunner.UserError(`mismatching content`, textRunner.errorMessage(err));
+    }
+}
+async function readFile(fileName, workspace) {
+    const filePath = workspace.joinStr(fileName);
+    try {
+        return await fs.readFile(filePath, "utf-8");
+    }
+    catch (e) {
+        if (!textRunner.isFsError(e)) {
+            throw e;
+        }
+        if (e.code === "ENOENT") {
+            const files = await fs.readdir(workspace.platformified());
+            throw new textRunner.UserError(`file not found: ${fileName}`, `the workspace has these files: ${files.join(", ")}`);
+        }
+        else {
+            throw e;
+        }
+    }
+}
+//# sourceMappingURL=compare-files.js.map

package/dist/actions/copy-file.js

@@ -0,0 +1,26 @@
+import { promises as fs } from "fs";
+import { styleText } from "node:util";
+import * as textRunner from "text-runner-engine";
+export async function copyFile(action) {
+    const src = action.region[0].attributes["src"];
+    if (!src) {
+        throw new textRunner.UserError("No src given", 'Please provide the file to copy via the "src" attribute');
+    }
+    const dst = action.region[0].attributes["dst"];
+    if (!dst) {
+        throw new textRunner.UserError("No dst given", 'Please provide the destination filename via the "dst" attribute');
+    }
+    action.name(`copy file ${styleText("cyan", src)} to ${styleText("cyan", dst)}`);
+    const srcPath = action.configuration.workspace.joinStr(src);
+    try {
+        await fs.access(srcPath, fs.constants.F_OK);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            throw new textRunner.UserError(`file "${src}" doesn't exist`, e.message);
+        }
+    }
+    const dstPath = action.configuration.workspace.joinStr(dst);
+    await fs.copyFile(srcPath, dstPath);
+}
+//# sourceMappingURL=copy-file.js.map

package/dist/index.js

@@ -1,4 +1,6 @@
 import { appendFile } from "./actions/append-file.js";
+import { compareFiles } from "./actions/compare-files.js";
+import { copyFile } from "./actions/copy-file.js";
 import { emptyFile } from "./actions/empty-file.js";
 import { existingDirectory } from "./actions/existing-directory.js";
 import { existingFileWithContent } from "./actions/existing-file-with-content.js";
@@ -8,6 +10,8 @@ import { newFile } from "./actions/new-file.js";
 import { workingDir } from "./actions/working-dir.js";
 export const textrunActions = {
     appendFile,
+    compareFiles,
+    copyFile,
     emptyFile,
     existingDirectory,
     existingFile,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textrun-workspace",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Text-Runner actions for the Text-Runner workspace",
   "license": "ISC",
   "type": "module",
@@ -18,14 +18,14 @@
   },
   "dependencies": {
     "assert-no-diff": "4.1.0",
-    "text-runner-engine": "7.3.0"
+    "text-runner-engine": "7.5.0"
   },
   "devDependencies": {
     "shared-cucumber-steps": "*",
-    "text-runner": "7.3.0",
-    "textrun-action": "0.5.0",
-    "textrun-extension": "0.5.0",
-    "tsx": "4.20.6"
+    "text-runner": "7.5.0",
+    "textrun-action": "0.7.0",
+    "textrun-extension": "0.7.0",
+    "tsx": "4.21.0"
   },
-  "gitHead": "b369f2fba1f9182c9c1d5569a351aa057dd81f1e"
+  "gitHead": "2373b67fd1ca2e81853cf50828376fcb6e6c8d85"
 }