bruniai 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,10 +18,10 @@ import { compareUrls } from "bruniai";
|
|
|
18
18
|
const result = await compareUrls({
|
|
19
19
|
baseUrl: "https://example.com",
|
|
20
20
|
previewUrl: "https://preview.example.com",
|
|
21
|
-
page: "/contact"
|
|
21
|
+
page: "/contact",
|
|
22
22
|
});
|
|
23
23
|
|
|
24
|
-
console.log(result.status); // "pass" | "fail" | "warning"
|
|
24
|
+
console.log(result.status); // "pass" | "fail" | "warning"
|
|
25
25
|
console.log(result.visual_analysis);
|
|
26
26
|
console.log(result.images.base_screenshot);
|
|
27
27
|
```
|
|
@@ -33,15 +33,15 @@ console.log(result.images.base_screenshot);
|
|
|
33
33
|
Performs a visual comparison between two URLs.
|
|
34
34
|
|
|
35
35
|
**Parameters:**
|
|
36
|
+
|
|
36
37
|
- `baseUrl` (string): Base/reference URL to compare against
|
|
37
38
|
- `previewUrl` (string): Preview/changed URL to analyze
|
|
38
39
|
- `page` (string, optional): Page path to compare (default: "/")
|
|
39
40
|
- `prNumber` (string, optional): PR number for metadata
|
|
40
41
|
- `repository` (string, optional): Repository name for metadata
|
|
41
|
-
- `prTitle` (string, optional): PR title for context
|
|
42
|
-
- `prDescription` (string, optional): PR description for context
|
|
43
42
|
|
|
44
43
|
**Returns:**
|
|
44
|
+
|
|
45
45
|
- `status`: Overall comparison status ("pass" | "fail" | "warning" | "none")
|
|
46
46
|
- `visual_analysis`: Detailed visual analysis result from AI
|
|
47
47
|
- `sections_analysis`: Formatted sections analysis text
|
|
@@ -72,4 +72,3 @@ npm run build
|
|
|
72
72
|
## License
|
|
73
73
|
|
|
74
74
|
MIT
|
|
75
|
-
|