textrun-repo 0.0.11 → 0.1.1

package/README.md

@@ -5,7 +5,7 @@ actions for verifying documentation containing the content of source code files
 from the repository.
 
 - [installation](#installation)
-- [repo/existing-file](#repoexisting-file)
+- [repo/existing-file-content](#repoexisting-file-content)
 - [repo/executable](#repoexecutable)
 
 ### installation
@@ -16,17 +16,38 @@ To use these actions, add this package as a development dependency by running
 
 ### repo/existing-file
 
+Sometimes you want to mention the name of a file from your application's source
+code in the documentation. The
+<b type="action/name-full">source/existing-file</b> action verifies this. As an
+example, consider a codebase contains a file
+<a type="workspace/new-file">**config.yml** with content `foo: bar`</a>. The
+documentation for this codebase might want to mention this configuration file:
+
+<a type="extension/runnable-region">
+
+```markdown
+The file <b type="repo/existing-file">config.yml</b> defines configuration
+values.
+```
+
+</a>
+
+The filename of the source code file is relative to the Markdown file describing
+it.
+
+### repo/existing-file-content
+
 Sometimes you want to just display a file from your application's source code in
-the documentation. The <b type="action/name-full">source/existing-file</b>
-action verifies such documentation. As an example, consider a codebase contains
-a file <a type="workspace/new-file">**config.yml** with content `foo: bar`</a>.
-The documentation for this codebase might want to mention this configuration
-file:
+the documentation. The
+<b type="action/name-full">source/existing-file-content</b> action verifies such
+documentation. As an example, consider a codebase contains a file
+<a type="workspace/new-file">**config.yml** with content `foo: bar`</a>. The
+documentation for this codebase might want to mention this configuration file:
 
 <a type="extension/runnable-region">
 
 ````markdown
-<a type="repo/existing-file">
+<a type="repo/existing-file-content">
 
 The **config.yml** file defines configuration values. The current settings are:
 
@@ -50,7 +71,7 @@ You can display its content in your documentation via this active region:
 <a type="extension/runnable-region">
 
 ```markdown
-<a type="repo/existing-file">
+<a type="repo/existing-file-content">
 
 The **hello.txt** file in the [bar folder](foo/bar) contains this section:
 

package/dist/existing-file-content.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.existingFileContent = void 0;
+const assertNoDiff = require("assert-no-diff");
+const color = require("colorette");
+const eol = require("eol");
+const fs_1 = require("fs");
+const path = require("path");
+const tr = require("text-runner-core");
+async function existingFileContent(action) {
+    const fileName = action.region.textInNodeOfType("em_open", "strong_open");
+    let relativeBaseDir = ".";
+    if (action.region.hasNodeOfType("link_open")) {
+        const linkNode = action.region.nodeOfTypes("link_open");
+        relativeBaseDir = linkNode.attributes.href;
+    }
+    const expectedContent = action.region.textInNodeOfTypes("fence", "code");
+    const filePath = path.join(action.location.file.directory().platformified(), relativeBaseDir, fileName);
+    action.name(`document content matches source code file ${color.cyan(filePath)}`);
+    const fullPath = action.configuration.sourceDir.joinStr(filePath);
+    action.log(`cat ${fullPath}`);
+    let actualContent;
+    try {
+        actualContent = await fs_1.promises.readFile(fullPath, "utf8");
+    }
+    catch (err) {
+        if (err.code === "ENOENT") {
+            throw new Error(`file not found: ${color.cyan(filePath)}`);
+        }
+        else {
+            throw err;
+        }
+    }
+    try {
+        assertNoDiff.trimmedLines(eol.lf(actualContent.trim()), eol.lf(expectedContent.trim()));
+    }
+    catch (err) {
+        throw new tr.UserError(`mismatching content in ${color.cyan(color.bold(filePath))}`, err.message);
+    }
+}
+exports.existingFileContent = existingFileContent;
+//# sourceMappingURL=existing-file-content.js.map

package/dist/existing-file.js

@@ -1,41 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.existingFile = void 0;
-const assertNoDiff = require("assert-no-diff");
 const color = require("colorette");
-const eol = require("eol");
 const fs_1 = require("fs");
-const path = require("path");
-const tr = require("text-runner-core");
 async function existingFile(action) {
-    const fileName = action.region.textInNodeOfType("em_open", "strong_open");
-    let relativeBaseDir = ".";
-    if (action.region.hasNodeOfType("link_open")) {
-        const linkNode = action.region.nodeOfTypes("link_open");
-        relativeBaseDir = linkNode.attributes.href;
-    }
-    const expectedContent = action.region.textInNodeOfTypes("fence", "code");
-    const filePath = path.join(action.location.file.directory().platformified(), relativeBaseDir, fileName);
-    action.name(`document content matches source code file ${color.cyan(filePath)}`);
-    const fullPath = action.configuration.sourceDir.joinStr(filePath);
+    const fileName = action.region.text();
+    action.name(`document mentions source code file ${color.cyan(fileName)}`);
+    const fullPath = action.configuration.sourceDir.joinStr(fileName);
     action.log(`ls ${fullPath}`);
-    let actualContent;
     try {
-        actualContent = await fs_1.promises.readFile(fullPath, "utf8");
+        var stats = await fs_1.promises.stat(fullPath);
     }
     catch (err) {
         if (err.code === "ENOENT") {
-            throw new Error(`file not found: ${color.cyan(filePath)}`);
+            throw new Error(`file not found: ${color.cyan(fileName)}`);
         }
         else {
             throw err;
         }
     }
-    try {
-        assertNoDiff.trimmedLines(eol.lf(actualContent.trim()), eol.lf(expectedContent.trim()));
-    }
-    catch (err) {
-        throw new tr.UserError(`mismatching content in ${color.cyan(color.bold(filePath))}`, err.message);
+    if (stats.isDirectory()) {
+        throw new Error(`expected ${color.cyan(fileName)} to be a file but is a directory`);
     }
 }
 exports.existingFile = existingFile;

package/dist/index.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.textrunActions = void 0;
 const executable_1 = require("./executable");
 const existing_file_1 = require("./existing-file");
+const existing_file_content_1 = require("./existing-file-content");
 exports.textrunActions = {
     executable: executable_1.executable,
     existingFile: existing_file_1.existingFile,
+    existingFileContent: existing_file_content_1.existingFileContent,
 };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textrun-repo",
-  "version": "0.0.11",
+  "version": "0.1.1",
   "description": "Text-Runner actions for verifying the content of the current repository",
   "main": "dist/index.js",
   "license": "ISC",
@@ -8,19 +8,19 @@
     "dist/**/*.js"
   ],
   "dependencies": {
+    "assert-no-diff": "3.0.6",
     "eol": "0.9.1",
-    "text-runner-core": "5.0.0-pre10"
+    "text-runner-core": "5.0.1"
   },
   "devDependencies": {
-    "assert-no-diff": "3.0.4",
-    "colorette": "1.2.1",
+    "colorette": "1.2.2",
     "cucumber": "6.0.5",
-    "mocha": "8.0.1",
+    "mocha": "9.2.0",
     "shared-cucumber-steps": "0.0.0",
-    "text-runner": "5.0.0-pre10",
-    "textrun-action": "0.0.11",
-    "textrun-extension": "0.0.11",
-    "textrun-npm": "0.0.11"
+    "text-runner": "5.0.1",
+    "textrun-action": "0.1.1",
+    "textrun-extension": "0.1.1",
+    "textrun-npm": "0.1.1"
   },
-  "gitHead": "0daa6e0620e60b423f4cde725936d61468b61a52"
+  "gitHead": "1380706cc871cb3a5adfeba9e996694c6d8bf892"
 }