textrun-workspace 0.2.1 → 0.3.1

package/README.md

@@ -1,38 +1,17 @@
-# Text-Runner Actions for the Text-Runner workspace
+# Text-Runner Actions for the Text-Runner test workspace
 
-This package provides [Text-Runner](https://github.com/kevgo/text-runner)
-actions for working with files.
-
-- [installation](#installation)
-- [cd action](#cd-action)
+Some Text-Runner actions create files and folders on disk. These files and
+folders get created in a temporary directory called the _workspace_ so that they
+don't interfere with the codebase that you document. This package provides
+[Text-Runner](https://github.com/kevgo/text-runner) actions for interacting with
+this Text-Runner workspace.
 
 ### installation
 
-To use these actions, add this package as a development dependency by running
-
-<pre type="npm/install">
-$ npm i -D textrun-workspace
-</pre>
-
-or
-
-<pre type="npm/install">
-$ yarn i -D textrun-workspace
-</pre>
-
-### cd action
+<a type="npm/install">
 
-The <b type="action/name-full">workspace/working-dir</b> action changes the
-current working directory into the given directory inside the workspace. As an
-example, consider the following documentation snippet:
-
-<a type="extension/runnable-region">
-
-```html
-Create a
-<code type="workspace/new-directory">foo</code>
-directory. Now you can change into it via this Markdown code:
-<code type="workspace/working-dir">foo</code>
+```
+npm i -D textrun-workspace
 ```
 
 </a>
@@ -54,35 +33,51 @@ When executing this Markdown snippet, Text-Runner will create a
 <i type="workspace/existing-directory">utils</i> directory in the workspace,
 just as the user would.
 
+### working-dir
+
+Each Text-Runner test starts in the workspace directory. The
+<b type="action/name-full">workspace/working-dir</b> action changes the current
+working directory of the test runner to the given directory inside the
+workspace. To change into the directory the reader created above:
+
+<a type="extension/runnable-region">
+
+```html
+Please change into the
+<code type="workspace/working-dir">utils</code>
+folder.
+```
+
+</a>
+
 ### create-file
 
 The <b type="action/name-full">workspace/new-file</b> action creates a file in
 the workspace. This action assumes that the documentation writes the filename in
-_emphasized_ or **bold** text and the file content as a code block with one or
-three backticks. As an example, consider the following documentation snippet:
+_emphasized_ or **bold** text, or inside a "filename" attribute, and the file
+content is a code block with one or three backticks. Here are a few examples:
 
 <a type="extension/runnable-region">
 
 ```markdown
-<a type="workspace/new-file">Please create a file _apples.txt_ with the content
-`Fuji`.</a>
-```
+<a type="workspace/new-file">
+
+Create file _apples.txt_ with the content `Fuji apples are the best`.
 
 </a>
+```
 
-When executing the documentation, Text-Runner will create a file with name
-<a type="workspace/existing-file">_apples.txt_ and content `Fuji`</a>.
-Alternatively, the documentation could also read like this:
+</a>
 
 <a type="extension/runnable-region">
 
 ````markdown
 <a type="workspace/new-file">
 
-Please create a file with name **more-apples.txt** and the content:
+Create file **apples.txt** with the content:
 
 ```
-Gala
+Fuji apples are the best
 ```
 
 </a>
@@ -90,8 +85,27 @@ Gala
 
 </a>
 
-Similarly, Text-Runner will create a file
-<a type="workspace/existing-file">_more-apples.txt_ with content `Gala`</a>.
+When executing the documentation, Text-Runner will create a file with name
+<a type="workspace/existing-file-with-content">_apples.txt_ and content
+`Fuji apples are the best`</a> in the workspace.
+
+### empty-file
+
+The <b type="action/name-full">workspace/empty-file</b> action creates an empty
+file.
+
+An example is this documentation:
+
+<a type="extension/runnable-region">
+
+```html
+Please create an empty file <b type="workspace/empty-file">.gitkeep</b>.
+```
+
+</a>
+
+When executing the documentation, Text-Runner will create a file with name
+<i type="workspace/existing-file">.gitkeep</i> in the workspace.
 
 ### directory
 
@@ -123,7 +137,7 @@ example, consider the following documentation snippet:
 Assuming a file <a type="workspace/new-file">_hello.txt_ with content
 `hello world`</a>, we can verify it via this action:
 
-<a type="workspace/existing-file">The file _hello.txt_ now contains
+<a type="workspace/existing-file-with-content">The file _hello.txt_ now contains
 `hello world`.</a>
 ```
 
@@ -146,7 +160,7 @@ Please create a file _apples.txt_ with the content `Boskoop`.
 
 </a>
 
-<a type="workspace/existing-file">
+<a type="workspace/existing-file-with-content">
 
 When executing the documentation, Text-Runner will create a file
 _subdir/apples.txt_ and content `Boskoop`

package/dist/actions/empty-file.js

@@ -0,0 +1,18 @@
+import * as color from "colorette";
+import { promises as fs } from "fs";
+import * as path from "path";
+import * as textRunner from "text-runner-engine";
+export async function emptyFile(action) {
+    var _a;
+    const fileName = action.region.text().trim();
+    if (fileName === "") {
+        throw new textRunner.UserError("No filename given", "");
+    }
+    const filePath = path.join((_a = action.region[0].attributes["dir"]) !== null && _a !== void 0 ? _a : ".", fileName);
+    action.name(`create file ${color.cyan(filePath)}`);
+    const fullPath = action.configuration.workspace.joinStr(filePath);
+    action.log(`create file ${filePath}`);
+    await fs.mkdir(path.dirname(fullPath), { recursive: true });
+    await fs.writeFile(fullPath, "");
+}
+//# sourceMappingURL=empty-file.js.map

package/dist/actions/existing-file-with-content.js

@@ -0,0 +1,35 @@
+import * as assertNoDiff from "assert-no-diff";
+import * as color from "colorette";
+import { promises as fs } from "fs";
+import * as path from "path";
+import * as textRunner from "text-runner-engine";
+export async function existingFileWithContent(action) {
+    const fileName = action.region.textInNodeOfType("strong", "em");
+    const fileRelPath = path.join(action.region[0].attributes["dir"] || ".", fileName);
+    action.name(`verify content of file ${color.cyan(fileRelPath)}`);
+    const fullPath = action.configuration.workspace.joinStr(fileRelPath);
+    const expectedContent = action.region.textInNodeOfType("fence", "code");
+    action.log(expectedContent);
+    try {
+        var actualContent = await fs.readFile(fullPath, "utf-8");
+    }
+    catch (e) {
+        if (!textRunner.isFsError(e)) {
+            throw e;
+        }
+        if (e.code === "ENOENT") {
+            const files = await fs.readdir(action.configuration.sourceDir.platformified());
+            throw new textRunner.UserError(`file not found: ${fileRelPath}`, `the workspace has these files: ${files.join(", ")}`);
+        }
+        else {
+            throw e;
+        }
+    }
+    try {
+        assertNoDiff.trimmedLines(actualContent.trim(), expectedContent.trim());
+    }
+    catch (err) {
+        throw new textRunner.UserError(`mismatching content in ${color.cyan(color.bold(fileRelPath))}`, textRunner.errorMessage(err));
+    }
+}
+//# sourceMappingURL=existing-file-with-content.js.map

package/dist/actions/existing-file.js

@@ -1,17 +1,14 @@
-import * as assertNoDiff from "assert-no-diff";
 import * as color from "colorette";
 import { promises as fs } from "fs";
 import * as path from "path";
-import * as textRunner from "text-runner-core";
+import * as textRunner from "text-runner-engine";
 export async function existingFile(action) {
-    const fileName = action.region.textInNodeOfType("strong", "em");
+    const fileName = action.region.text();
     const fileRelPath = path.join(action.region[0].attributes["dir"] || ".", fileName);
-    action.name(`verify content of file ${color.cyan(fileRelPath)}`);
+    action.name(`verify existence of file ${color.cyan(fileRelPath)}`);
     const fullPath = action.configuration.workspace.joinStr(fileRelPath);
-    const expectedContent = action.region.textInNodeOfType("fence", "code");
-    action.log(expectedContent);
     try {
-        var actualContent = await fs.readFile(fullPath, "utf-8");
+        await fs.stat(fullPath);
     }
     catch (e) {
         if (!textRunner.isFsError(e)) {
@@ -25,11 +22,5 @@ export async function existingFile(action) {
             throw e;
         }
     }
-    try {
-        assertNoDiff.trimmedLines(actualContent.trim(), expectedContent.trim());
-    }
-    catch (err) {
-        throw new textRunner.UserError(`mismatching content in ${color.cyan(color.bold(fileRelPath))}`, textRunner.errorMessage(err));
-    }
 }
 //# sourceMappingURL=existing-file.js.map

package/dist/actions/new-file.js

@@ -1,11 +1,12 @@
 import * as color from "colorette";
 import { promises as fs } from "fs";
 import * as path from "path";
-import * as textRunner from "text-runner-core";
+import * as textRunner from "text-runner-engine";
 export async function newFile(action) {
     var _a;
+    let fileName = action.region[0].attributes["filename"] || "";
     try {
-        var fileName = action.region.textInNodeOfType("em", "strong");
+        fileName || (fileName = action.region.textInNodeOfType("em", "strong"));
     }
     catch (e) {
         if (!textRunner.isUserError(e)) {

package/dist/actions/working-dir.js

@@ -1,5 +1,5 @@
 import * as color from "colorette";
-import * as textRunner from "text-runner-core";
+import * as textRunner from "text-runner-engine";
 /** The "cd" action changes the current working directory to the one given in the hyperlink or code block. */
 export function workingDir(action) {
     const directory = action.region.text();

package/dist/index.js

@@ -1,15 +1,19 @@
 import { additionalFileContent } from "./actions/additional-file-content.js";
+import { emptyFile } from "./actions/empty-file.js";
 import { existingDirectory } from "./actions/existing-directory.js";
+import { existingFileWithContent } from "./actions/existing-file-with-content.js";
 import { existingFile } from "./actions/existing-file.js";
 import { newDirectory } from "./actions/new-directory.js";
 import { newFile } from "./actions/new-file.js";
 import { workingDir } from "./actions/working-dir.js";
 export const textrunActions = {
     additionalFileContent,
-    workingDir,
-    newFile,
+    emptyFile,
     existingDirectory,
     existingFile,
+    existingFileWithContent,
     newDirectory,
+    newFile,
+    workingDir
 };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textrun-workspace",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Text-Runner actions for the Text-Runner workspace",
   "license": "ISC",
   "type": "module",
@@ -10,23 +10,23 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig-build.json",
-    "clean": "rm -rf dist",
     "cuke": "cucumber-js --format=progress",
-    "doc": "text-run static --online --format=summary && text-run dynamic --format=progress",
-    "fix": "eslint --fix --ignore-pattern=dist/ . && prettier --write .",
-    "lint": "prettier -l . && eslint --ignore-pattern=dist/ . && depcheck"
+    "doc": "text-runner",
+    "fix": "eslint --fix --ignore-pattern=dist/ . && dprint fmt && sort-package-json --quiet",
+    "lint": "dprint check && sort-package-json --check --quiet && eslint --ignore-pattern=dist/ . && depcheck",
+    "reset": "rm -rf dist && yarn run build"
   },
   "dependencies": {
-    "assert-no-diff": "3.0.6",
+    "assert-no-diff": "4.1.0",
     "colorette": "2.0.20",
-    "text-runner-core": "6.0.1"
+    "text-runner-engine": "7.1.2"
   },
   "devDependencies": {
     "shared-cucumber-steps": "*",
-    "text-runner": "6.0.1",
-    "textrun-action": "0.2.1",
-    "textrun-extension": "0.2.1",
+    "text-runner": "7.1.2",
+    "textrun-action": "0.3.1",
+    "textrun-extension": "0.3.1",
     "tsx": "4.19.3"
   },
-  "gitHead": "e479ff08fba71c7b2f6d1e3e14001b7818a38e12"
+  "gitHead": "8aa3f5d9fbf24776eae6516b96ebde4863ad33a2"
 }