@test2doc/playwright 0.13.1 → 0.14.1

package/README.md

@@ -97,14 +97,14 @@ The `TEST2DOC=true` is required to activate the test2doc metadata to pass to the
   ...
   "scripts": {
     ...
-    "docs:generate": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts"
+    "doc:gen": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts"
   }
   ...
 }
 ```
 
 ## Verify installation
-To verify your setup works, run `npm run docs:generate` and check that markdown files appear in your `./doc/docs` directory, or wherever you specified the output directory in the `playwright-test2doc.config.ts` file.
+To verify your setup works, run `npm run doc:gen` and check that markdown files appear in your `./doc/docs` directory, or wherever you specified the output directory in the `playwright-test2doc.config.ts` file.
 
 ## Filtering Tests
 It is possible you may wish to opt-in some tests or opt-out other tests from doc generation. This is possible with playwright tags.
@@ -151,7 +151,7 @@ Run only tests with the `@test2doc` tag.
   ...
   "scripts": {
     ...
-    "docs:generate": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep @test2doc"
+    "doc:gen": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep @test2doc"
   }
   ...
 }
@@ -168,7 +168,7 @@ Skip tests with the `@skip-docs` tag.
   ...
   "scripts": {
     ...
-    "docs:generate": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep-invert @skip-docs"
+    "doc:gen": "TEST2DOC=true playwright test --config=playwright-test2doc.config.ts --grep-invert @skip-docs"
   }
   ...
 }
@@ -361,9 +361,9 @@ To style the highlight and label we expose a few properties on the `annotation`
   - **Default**: `2`
 
 - **`position`**:
-  - **Type**: `"above" | "below" | "left" | "right"`
-  - **Description**: Determines the position of the label text relative to the highlighted element.
-  - **Default**: `"below"` - automatically repositioned if insufficient space below the element.
+  - **Type**: `"above" | "below" | "left" | "right" | number`
+  - **Description**: Determines the position of the label text relative to the highlighted element. Uses clock convention where 0° = top, 90° = right, etc. If a number is provided, it positions the label at that degree angle. Defaults to automatically positioning towards the screen center.
+  - **Default**: Automatically positions label towards the center of the screen.
 - **`showArrow`**:
   - **Type**: `boolean`
   - **Description**: Whether to display an arrow pointing from the label to the highlighted element. When enabled, creates a visual connection between the annotation text and the target element.
@@ -439,7 +439,6 @@ export default defineConfig({
 })
 ```
 
-
 #### Highlight multiple elements
 In the event that you need to highlight multiple elements, you can pass in an array with `MultiLocatorScreenshot` objects.
 
@@ -469,7 +468,7 @@ test.describe(withDocMeta("describe block"), async () => {
               options: {
                 annotation: {
                   text: "Sidebar Element",
-                  position: "left",
+                  position: 270,
                   showArrow: true,
                   arrowStrokeStyle: "red",
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@test2doc/playwright",
-  "version": "0.13.1",
+  "version": "0.14.1",
   "description": "A reporter that generates docs based off playwright test files",
   "keywords": [
     "documentation",