docs: Add example showing usePackageLock

.github/workflows/test.yml

@@ -47,3 +47,16 @@ jobs:
         with:
           working-directory: ./examples/browser_profile
           concurrency: 10
+
+  react:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run saucectl
+        uses: saucelabs/saucectl-run-action@v4
+        with:
+          working-directory: ./examples/react
+          concurrency: 10
+

examples/react/.sauce/config.yml

@@ -0,0 +1,36 @@
+apiVersion: v1alpha
+kind: testcafe
+sauce:
+  region: us-west-1
+  concurrency: 2
+  metadata:
+    tags:
+      - e2e
+      - release team
+      - other tag
+testcafe:
+  version: 3.6.2
+  configFile: .testcaferc.js
+# Controls what files are available in the context of a test run (unless explicitly excluded by .sauceignore).
+rootDir: ./
+suites:
+  - name: "testcafe react example - firefox"
+    browserName: "firefox"
+    src:
+      - "tests/*.test.ts"
+    platformName: "Windows 11"
+
+# Controls what artifacts to fetch when the suites have finished.
+artifacts:
+  download:
+    when: always
+    match:
+      - console.log
+    directory: ./artifacts/
+
+reporters:
+  spotlight: # Prints an overview of failed or otherwise interesting jobs.
+    enabled: true
+
+npm:
+  usePackageLock: true

examples/react/.sauceignore

@@ -0,0 +1 @@
+node_modules

examples/react/.testcaferc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  disableNativeAutomation: true,
+};

examples/react/README.md

@@ -0,0 +1,48 @@
+# saucectl TestCafe & React Example
+
+This example demonstrates how to use a test time dependency when running your
+TestCafe tests with saucectl.
+
+## What You'll Need
+
+The steps below illustrate one of the quickest ways to get set up. If you'd like
+a more in-depth guide, please check out our 
+[documentation](https://docs.saucelabs.com/dev/cli/saucectl/#installing-saucectl).
+
+### Install `saucectl`
+
+```sh
+npm install -g saucectl
+```
+
+### Set Your Sauce Labs Credentials
+
+```sh
+saucectl configure
+```
+
+## Running The Examples
+
+Simply check out this repo, navigate into `examples/react` and run the
+command below :rocket:
+
+```sh
+saucectl run
+```
+
+## Configuration
+
+The test in this example requires the
+[testcafe-react-selectors](https://github.com/DevExpress/testcafe-react-selectors)
+package so it needs to be available in the test environment. We can define a
+list of packages to install before test execution in the saucectl configuration
+file.
+
+```yaml
+npm:
+  usePackageLock: true
+```
+
+Enabling the `usePackageLock` option ensures that the project's package.json and
+package-lock.json are used during package installation. In most cases, this will
+reduce the time needed for package installation.