testdriverai 5.3.12 → 5.3.14

package/styles/write-good/Illusions.yml

@@ -0,0 +1,11 @@
+extends: repetition
+message: "'%s' is repeated!"
+level: warning
+alpha: true
+action:
+  name: edit
+  params:
+    - truncate
+    - " "
+tokens:
+  - '[^\s]+'

package/styles/write-good/Passive.yml

@@ -0,0 +1,183 @@
+extends: existence
+message: "'%s' may be passive voice. Use active voice if you can."
+ignorecase: true
+level: warning
+raw:
+  - \b(am|are|were|being|is|been|was|be)\b\s*
+tokens:
+  - '[\w]+ed'
+  - awoken
+  - beat
+  - become
+  - been
+  - begun
+  - bent
+  - beset
+  - bet
+  - bid
+  - bidden
+  - bitten
+  - bled
+  - blown
+  - born
+  - bought
+  - bound
+  - bred
+  - broadcast
+  - broken
+  - brought
+  - built
+  - burnt
+  - burst
+  - cast
+  - caught
+  - chosen
+  - clung
+  - come
+  - cost
+  - crept
+  - cut
+  - dealt
+  - dived
+  - done
+  - drawn
+  - dreamt
+  - driven
+  - drunk
+  - dug
+  - eaten
+  - fallen
+  - fed
+  - felt
+  - fit
+  - fled
+  - flown
+  - flung
+  - forbidden
+  - foregone
+  - forgiven
+  - forgotten
+  - forsaken
+  - fought
+  - found
+  - frozen
+  - given
+  - gone
+  - gotten
+  - ground
+  - grown
+  - heard
+  - held
+  - hidden
+  - hit
+  - hung
+  - hurt
+  - kept
+  - knelt
+  - knit
+  - known
+  - laid
+  - lain
+  - leapt
+  - learnt
+  - led
+  - left
+  - lent
+  - let
+  - lighted
+  - lost
+  - made
+  - meant
+  - met
+  - misspelt
+  - mistaken
+  - mown
+  - overcome
+  - overdone
+  - overtaken
+  - overthrown
+  - paid
+  - pled
+  - proven
+  - put
+  - quit
+  - read
+  - rid
+  - ridden
+  - risen
+  - run
+  - rung
+  - said
+  - sat
+  - sawn
+  - seen
+  - sent
+  - set
+  - sewn
+  - shaken
+  - shaven
+  - shed
+  - shod
+  - shone
+  - shorn
+  - shot
+  - shown
+  - shrunk
+  - shut
+  - slain
+  - slept
+  - slid
+  - slit
+  - slung
+  - smitten
+  - sold
+  - sought
+  - sown
+  - sped
+  - spent
+  - spilt
+  - spit
+  - split
+  - spoken
+  - spread
+  - sprung
+  - spun
+  - stolen
+  - stood
+  - stridden
+  - striven
+  - struck
+  - strung
+  - stuck
+  - stung
+  - stunk
+  - sung
+  - sunk
+  - swept
+  - swollen
+  - sworn
+  - swum
+  - swung
+  - taken
+  - taught
+  - thought
+  - thrived
+  - thrown
+  - thrust
+  - told
+  - torn
+  - trodden
+  - understood
+  - upheld
+  - upset
+  - wed
+  - wept
+  - withheld
+  - withstood
+  - woken
+  - won
+  - worn
+  - wound
+  - woven
+  - written
+  - wrung

package/styles/write-good/README.md

@@ -0,0 +1,27 @@
+Based on [write-good](https://github.com/btford/write-good).
+
+> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2014 Brian Ford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

package/styles/write-good/So.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Don't start a sentence with '%s'."
+level: error
+raw:
+  - '(?:[;-]\s)so[\s,]|\bSo[\s,]'

package/styles/write-good/ThereIs.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: "Don't start a sentence with '%s'."
+ignorecase: false
+level: error
+raw:
+  - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'

package/styles/write-good/TooWordy.yml

@@ -0,0 +1,221 @@
+extends: existence
+message: "'%s' is too wordy."
+ignorecase: true
+level: warning
+tokens:
+  - a number of
+  - abundance
+  - accede to
+  - accelerate
+  - accentuate
+  - accompany
+  - accomplish
+  - accorded
+  - accrue
+  - acquiesce
+  - acquire
+  - additional
+  - adjacent to
+  - adjustment
+  - admissible
+  - advantageous
+  - adversely impact
+  - advise
+  - aforementioned
+  - aggregate
+  - aircraft
+  - all of
+  - all things considered
+  - alleviate
+  - allocate
+  - along the lines of
+  - already existing
+  - alternatively
+  - amazing
+  - ameliorate
+  - anticipate
+  - apparent
+  - appreciable
+  - as a matter of fact
+  - as a means of
+  - as far as I'm concerned
+  - as of yet
+  - as to
+  - as yet
+  - ascertain
+  - assistance
+  - at the present time
+  - at this time
+  - attain
+  - attributable to
+  - authorize
+  - because of the fact that
+  - belated
+  - benefit from
+  - bestow
+  - by means of
+  - by virtue of
+  - by virtue of the fact that
+  - cease
+  - close proximity
+  - commence
+  - comply with
+  - concerning
+  - consequently
+  - consolidate
+  - constitutes
+  - demonstrate
+  - depart
+  - designate
+  - discontinue
+  - due to the fact that
+  - each and every
+  - economical
+  - eliminate
+  - elucidate
+  - employ
+  - endeavor
+  - enumerate
+  - equitable
+  - equivalent
+  - evaluate
+  - evidenced
+  - exclusively
+  - expedite
+  - expend
+  - expiration
+  - facilitate
+  - factual evidence
+  - feasible
+  - finalize
+  - first and foremost
+  - for all intents and purposes
+  - for the most part
+  - for the purpose of
+  - forfeit
+  - formulate
+  - have a tendency to
+  - honest truth
+  - however
+  - if and when
+  - impacted
+  - implement
+  - in a manner of speaking
+  - in a timely manner
+  - in a very real sense
+  - in accordance with
+  - in addition
+  - in all likelihood
+  - in an effort to
+  - in between
+  - in excess of
+  - in lieu of
+  - in light of the fact that
+  - in many cases
+  - in my opinion
+  - in order to
+  - in regard to
+  - in some instances
+  - in terms of
+  - in the case of
+  - in the event that
+  - in the final analysis
+  - in the nature of
+  - in the near future
+  - in the process of
+  - inception
+  - incumbent upon
+  - indicate
+  - indication
+  - initiate
+  - irregardless
+  - is applicable to
+  - is authorized to
+  - is responsible for
+  - it is
+  - it is essential
+  - it seems that
+  - it was
+  - magnitude
+  - maximum
+  - methodology
+  - minimize
+  - minimum
+  - modify
+  - monitor
+  - multiple
+  - necessitate
+  - nevertheless
+  - not certain
+  - not many
+  - not often
+  - not unless
+  - not unlike
+  - notwithstanding
+  - null and void
+  - numerous
+  - objective
+  - obligate
+  - obtain
+  - on the contrary
+  - on the other hand
+  - one particular
+  - optimum
+  - overall
+  - owing to the fact that
+  - participate
+  - particulars
+  - pass away
+  - pertaining to
+  - point in time
+  - portion
+  - possess
+  - preclude
+  - previously
+  - prior to
+  - prioritize
+  - procure
+  - proficiency
+  - provided that
+  - purchase
+  - put simply
+  - readily apparent
+  - refer back
+  - regarding
+  - relocate
+  - remainder
+  - remuneration
+  - requirement
+  - reside
+  - residence
+  - retain
+  - satisfy
+  - shall
+  - should you wish
+  - similar to
+  - solicit
+  - span across
+  - strategize
+  - subsequent
+  - substantial
+  - successfully complete
+  - sufficient
+  - terminate
+  - the month of
+  - the point I am trying to make
+  - therefore
+  - time period
+  - took advantage of
+  - transmit
+  - transpire
+  - type of
+  - until such time as
+  - utilization
+  - utilize
+  - validate
+  - various different
+  - what I mean to say is
+  - whether or not
+  - with respect to
+  - with the exception of
+  - witnessed

package/styles/write-good/Weasel.yml

@@ -0,0 +1,29 @@
+extends: existence
+message: "'%s' is a weasel word!"
+ignorecase: true
+level: warning
+tokens:
+  - clearly
+  - completely
+  - exceedingly
+  - excellent
+  - extremely
+  - fairly
+  - huge
+  - interestingly
+  - is a number
+  - largely
+  - mostly
+  - obviously
+  - quite
+  - relatively
+  - remarkably
+  - several
+  - significantly
+  - substantially
+  - surprisingly
+  - tiny
+  - usually
+  - various
+  - vast
+  - very

package/styles/write-good/meta.json

@@ -0,0 +1,4 @@
+{
+  "feed": "https://github.com/errata-ai/write-good/releases.atom",
+  "vale_version": ">=1.0.0"
+}

package/testdriver/testdriver_2025-04-17T16-04-30-454Z.yaml

@@ -0,0 +1,6 @@
+version: 5.3.13
+session: 680126994a12078ae2a74ee5
+steps:
+  - prompt: /try log in
+    commands: []
+A

package/vale.ini

@@ -0,0 +1,18 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+
+Packages = Microsoft, proselint, MDX
+
+# Here's were we define the exceptions to use in *all*
+# `BasedOnStyles`.
+Vocab = Docs
+
+[*]
+
+[formats]
+mdx = md
+
+[*.mdx]
+CommentDelimiters = {/*, */}
+BasedOnStyles = Vale, Microsoft, proselint

package/docs/guide/setup-teardown.mdx

@@ -1,162 +0,0 @@
----
-title: "Setup & Teardown"
-sidebarTitle: "Setup & Teardown"
-description: "Learn how to effectively describe and locate elements using TestDriver.ai's visual understanding capabilities."
-icon: "hammer"
----
-
-
-When running tests with **TestDriver.ai** in GitHub Actions, it's important to handle **setup** and **teardown** tasks properly. Setup tasks should be performed **before** the TestDriver.ai action (e.g., creating a new user via an API), and teardown tasks should be performed **after** the TestDriver.ai action, ensuring cleanup happens regardless of the test results.
-
-This guide explains how to structure your workflow to handle setup and teardown tasks effectively.
-
----
-
-## Workflow Overview
-
-1. **Setup Tasks**:
-   - Use a dedicated action **before** the TestDriver.ai action to prepare the environment (e.g., create a test user via an API).
-   - Pass the created user credentials to the TestDriver.ai action using environment variables.
-
-2. **Run Tests**:
-   - Execute the tests using TestDriver.ai, leveraging the setup data (e.g., the test user).
-
-3. **Teardown Tasks**:
-   - Use a dedicated action **after** the TestDriver.ai action to clean up (e.g., delete the test user).
-   - Ensure the teardown step runs **no matter the result** of the TestDriver.ai action.
-
----
-
-## Example Workflow with Setup and Teardown
-
-### Workflow File: `.github/workflows/testdriver-setup-teardown.yml`
-
-```yaml
-name: TestDriver.ai with Setup and Teardown
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-  workflow_dispatch:
-
-jobs:
-  test:
-    name: "TestDriver with Setup and Teardown"
-    runs-on: ubuntu-latest
-    steps:
-      # Step 1: Check out the repository
-      - name: Check out repository
-        uses: actions/checkout@v2
-
-      # Step 2: Setup - Create a test user via API
-      - name: Setup Test User
-        id: setup-user
-        run: |
-          echo "Creating test user via API..."
-          RESPONSE=$(curl -X POST -H "Content-Type: application/json" -d '{"name": "Test User", "email": "test@example.com", "password": "password123"}' https://api.example.com/users)
-          echo "USER_ID=$(echo $RESPONSE | jq -r '.id')" >> $GITHUB_ENV
-          echo "USER_EMAIL=$(echo $RESPONSE | jq -r '.email')" >> $GITHUB_ENV
-          echo "USER_PASSWORD=password123" >> $GITHUB_ENV
-        env:
-          API_KEY: ${{ secrets.API_KEY }}
-
-      # Step 3: Run Tests with TestDriver.ai
-      - name: Run Tests with TestDriver.ai
-        uses: testdriverai/action@main
-        with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
-          prompt: |
-            1. Log in with the test user
-            2. Perform actions on the dashboard
-          prerun: |
-            echo "Launching browser with test user credentials..."
-            echo "Email: $USER_EMAIL"
-            echo "Password: $USER_PASSWORD"
-        env:
-          USER_EMAIL: ${{ env.USER_EMAIL }}
-          USER_PASSWORD: ${{ env.USER_PASSWORD }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          FORCE_COLOR: "3"
-
-      # Step 4: Teardown - Delete the test user
-      - name: Teardown Test User
-        if: always()
-        run: |
-          echo "Deleting test user via API..."
-          curl -X DELETE -H "Authorization: Bearer ${{ secrets.API_KEY }}" https://api.example.com/users/$USER_ID
-          echo "Test user deleted."
-        env:
-          USER_ID: ${{ env.USER_ID }}
-          API_KEY: ${{ secrets.API_KEY }}```
-
-
----
-
-## Workflow Steps Explained
-
-### 1. **Setup Test User**
-- **Purpose**: Create a test user via an API before running the tests.
-- **How It Works**:
-  - The `Setup Test User` step sends a `POST` request to the API to create a new user.
-  - The user ID, email, and password are extracted from the API response and stored as environment variables (`USER_ID`, `USER_EMAIL`, `USER_PASSWORD`).
-- **Example Output**:
-  - `USER_ID`: `12345`
-  - `USER_EMAIL`: `test@example.com`
-  - `USER_PASSWORD`: `password123`
-
----
-
-### 2. **Run Tests with TestDriver.ai**
-- **Purpose**: Execute tests using the TestDriver.ai action.
-- **How It Works**:
-  - The `USER_EMAIL` and `USER_PASSWORD` environment variables are passed to the `prerun` script.
-  - The test prompts use these credentials to log in and perform actions.
-
----
-
-### 3. **Teardown Test User**
-- **Purpose**: Delete the test user via an API after the tests are complete.
-- **How It Works**:
-  - The `Teardown Test User` step sends a `DELETE` request to the API to remove the test user.
-  - The `if: always()` condition ensures this step runs even if the TestDriver.ai action fails.
-
----
-
-## Best Practices for Setup and Teardown
-
-1. **Use APIs for Setup and Teardown**:
-   - Use APIs to create and delete test data dynamically, ensuring a clean environment for each test run.
-
-2. **Pass Data via Environment Variables**:
-   - Store setup data (e.g., user credentials) in environment variables and pass them to the TestDriver.ai action.
-
-3. **Ensure Teardown Always Runs**:
-   - Use `if: always()` to ensure teardown tasks are executed regardless of the test results.
-
-4. **Log Setup and Teardown Steps**:
-   - Add `echo` statements to log the progress of setup and teardown tasks for easier debugging.
-
-5. **Test Locally**:
-   - Verify setup and teardown scripts locally before integrating them into the workflow.
-
----
-
-## Example Use Cases
-
-### 1. **User Management**
-- Create a test user during setup.
-- Delete the test user during teardown.
-
-### 2. **Database Operations**
-- Insert test data into a database during setup.
-- Remove the test data during teardown.
-
-### 3. **Mock Services**
-- Start a mock API server during setup.
-- Stop the mock server during teardown.
-
----
-
-By structuring your workflow to handle **setup** before the TestDriver.ai action and **teardown** after it, you can ensure a clean and reliable test environment for every run. This approach also ensures that teardown tasks are executed regardless of the test results, maintaining a consistent state for subsequent runs.