@web/test-runner-commands - npm Package Compare versions

Comparing version 0.4.4 to 0.4.5

browser/commands.d.ts

@@ -5,2 +5,3 @@ import { Media } from '../dist/index';
 import { A11ySnapshotPayload } from '../dist/index';
+import { WriteFilePayload, ReadFilePayload, RemoveFilePayload } from '../dist/index';
 
@@ -121,2 +122,44 @@ /**
 
-export { Media, Viewport, SendKeysPayload };
+/**
+ * Writes a file to disk.
+ *
+ * @param payload.filePath the path of the file to save. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ * @param payload.content the file content to save as a string.
+ * @param payload.encoding optional encoding to use when saving the file.
+ *
+ * @example
+ * ```ts
+ *    await writeFile('hello-world.txt', "Hello world!");
+ * ```
+ */
+export function writeFile(payload: WriteFilePayload): Promise<void>;
+
+/**
+ * Reads a file from disk.
+ *
+ * @param payload.filePath the path of the file to read. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ * @param payload.encoding optional encoding to use when reading the file.
+ *
+ * @example
+ * ```ts
+ *    const content = await readFile('hello-world.txt');
+ * ```
+ */
+export function readFile(payload: WriteFilePayload): Promise<string>;
+
+/**
+ * Removes a file from disk.
+ *
+ * @param payload.filePath the path of the file to remove. This is a path relative to the test file
+ * being executed. It cannot be an absolute path.
+ *
+ * @example
+ * ```ts
+ *    await removeFile('hello-world.txt');
+ * ```
+ */
+export function removeFile(payload: RemoveFilePayload): Promise<string>;
+
+export { Media, Viewport, SendKeysPayload, WriteFilePayload, ReadFilePayload, RemoveFilePayload };

CHANGELOG.md

 # @web/test-runner-commands
 
+## 0.4.5
+
+### Patch Changes
+
+- 21f53211: add commands for reading/writing files
+
 ## 0.4.4
@@ -4,0 +10,0 @@

dist/index.d.ts

@@ -6,2 +6,3 @@ export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { a11ySnapshotPlugin, A11ySnapshotPayload } from './a11ySnapshotPlugin';
+export { WriteFilePayload, ReadFilePayload, RemoveFilePayload, filePlugin } from './filePlugin';
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.a11ySnapshotPlugin = exports.sendKeysPlugin = exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
+exports.filePlugin = exports.a11ySnapshotPlugin = exports.sendKeysPlugin = exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
 var setViewportPlugin_1 = require("./setViewportPlugin");
@@ -14,2 +14,4 @@ Object.defineProperty(exports, "setViewportPlugin", { enumerable: true, get: function () { return setViewportPlugin_1.setViewportPlugin; } });
 Object.defineProperty(exports, "a11ySnapshotPlugin", { enumerable: true, get: function () { return a11ySnapshotPlugin_1.a11ySnapshotPlugin; } });
+var filePlugin_1 = require("./filePlugin");
+Object.defineProperty(exports, "filePlugin", { enumerable: true, get: function () { return filePlugin_1.filePlugin; } });
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@web/test-runner-commands",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "publishConfig": {
@@ -48,3 +48,4 @@ "access": "public"
   "dependencies": {
-    "@web/test-runner-core": "^0.10.14"
+    "@web/test-runner-core": "^0.10.14",
+    "mkdirp": "^1.0.4"
   },
@@ -51,0 +52,0 @@ "devDependencies": {

src/index.ts

@@ -6,1 +6,2 @@ export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { a11ySnapshotPlugin, A11ySnapshotPayload } from './a11ySnapshotPlugin';
+export { WriteFilePayload, ReadFilePayload, RemoveFilePayload, filePlugin } from './filePlugin';

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

58509

increased by28.78%

Number of package files

44

increased by12.82%

Lines of code

956

increased by35.8%

Worsened metrics

Dependency count

2

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedmkdirp@^1.0.4

• + Addedmkdirp@1.0.4(transitive)