@crabnebula/test-runner-backend 0.0.0 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## \[0.1.0]
+
+- [`bc81b34`](https://github.com/crabnebula-dev/webdriver/commit/bc81b34090682a3c11556267ac469881a576f1bc) ([#33](https://github.com/crabnebula-dev/webdriver/pull/33) by [@enes-crabnebula](https://github.com/crabnebula-dev/webdriver/../../enes-crabnebula)) -   Fix tauri updater plugin crash on macOS.
+  - Fix crash on automation plugin crash on init.
+- [`46b3a45`](https://github.com/crabnebula-dev/webdriver/commit/46b3a45f0321b88eead1242e70336eec1cffda7b) ([#28](https://github.com/crabnebula-dev/webdriver/pull/28) by [@lucasfernog-crabnebula](https://github.com/crabnebula-dev/webdriver/../../lucasfernog-crabnebula)) Add documentation.

package/README.md

@@ -0,0 +1,29 @@
+# CrabNebula Webdriver for Tauri Test Runner
+
+This package provides a test runner API service for the CrabNebula Webdriver for Tauri.
+
+It lets you run integration tests locally leveraging CrabNebula's Webdriver.
+
+## Installation
+
+Install with your favorite package manager:
+
+```sh
+npm install --save-dev @crabnebula/test-runner-backend
+yarn install -D @crabnebula/test-runner-backend
+pnpm install -D @crabnebula/test-runner-backend
+```
+
+Then you can execute the `test-runner-backend` binary:
+
+```sh
+npm run test-runner-backend # requires a `{ "test-runner-backend": "test-runner-backend" }` script in package.json
+yarn test-runner-backend
+pnpm test-runner-backend
+```
+
+## Usage
+
+To actually run integration tests leverating this backend, you should use the [@crabnebula/tauri-driver](https://www.npmjs.com/package/@crabnebula/tauri-driver) package, which works cross platform and can communicate with this test runner seamlessly.
+
+See the [@crabnebula/tauri-driver documentation](https://www.npmjs.com/package/@crabnebula/tauri-driver) for more information.

package/build.rs

@@ -1,5 +1,5 @@
 extern crate napi_build;
 
 fn main() {
-  napi_build::setup();
+    napi_build::setup();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crabnebula/test-runner-backend",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "main": "index.js",
   "types": "index.d.ts",
   "bin": {
@@ -31,9 +31,9 @@
     "version": "napi version"
   },
   "optionalDependencies": {
-    "@crabnebula/test-runner-backend-win32-x64-msvc": "0.0.0",
-    "@crabnebula/test-runner-backend-darwin-x64": "0.0.0",
-    "@crabnebula/test-runner-backend-linux-x64-gnu": "0.0.0",
-    "@crabnebula/test-runner-backend-darwin-arm64": "0.0.0"
+    "@crabnebula/test-runner-backend-win32-x64-msvc": "0.1.0",
+    "@crabnebula/test-runner-backend-darwin-x64": "0.1.0",
+    "@crabnebula/test-runner-backend-linux-x64-gnu": "0.1.0",
+    "@crabnebula/test-runner-backend-darwin-arm64": "0.1.0"
   }
 }

package/src/lib.rs

@@ -2,7 +2,7 @@ use napi::Result;
 
 #[napi_derive::napi]
 pub async fn run(args: Vec<String>, bin_name: Option<String>) -> Result<()> {
-  test_runner_backend::try_run(args, bin_name)
-    .await
-    .map_err(|e| napi::Error::new(napi::Status::GenericFailure, e.to_string()))
+    test_runner_backend::try_run(args, bin_name)
+        .await
+        .map_err(|e| napi::Error::new(napi::Status::GenericFailure, e.to_string()))
 }