Merge branch 'dev' of github.com:estruyf/playwright-github-actions-reporter into dev

Author: estruyf

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.9.1]
+
+- [#20](https://github.com/estruyf/playwright-github-actions-reporter/issues/20): Add declaration file to the package
+
 ## [1.9.0]
 
 - [#17](https://github.com/estruyf/playwright-github-actions-reporter/issues/17): Added the ability to define which types of test results should be shown in the summary

README.md

@@ -38,7 +38,7 @@ The reporter supports the following configuration options:
 | showAnnotations | Show annotations from tests | `true` |
 | showTags | Show tags from tests | `true` |
 | showError | Show error message in summary | `false` |
-| report | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
+| includeResults | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
 | quiet | Do not show any output in the console | `false` |
 
 To use these option, you can update the reporter configuration:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@estruyf/github-actions-reporter",
-  "version": "1.9.0",
+  "version": "1.9.1",
   "description": "GitHub Actions reporter for Playwright",
   "main": "dist/index.js",
   "scripts": {

package.json

@@ -20,7 +20,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         useDetails: false,
         showError: true,
         quiet: false,
-        report: ["fail", "flaky", "skipped"],
+        includeResults: ["fail", "flaky", "skipped"],
       },
     ],
     [
@@ -30,7 +30,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         useDetails: false,
         showError: true,
         quiet: false,
-        report: ["pass", "skipped"],
+        includeResults: ["pass", "skipped"],
       },
     ],
     [
@@ -39,7 +39,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
         title: "Reporter (details: true, report: fail, flaky, skipped)",
         useDetails: true,
         quiet: true,
-        report: ["fail", "flaky", "skipped"],
+        includeResults: ["fail", "flaky", "skipped"],
       },
     ],
   ],

playwright.config.ts

@@ -31,8 +31,8 @@ class GitHubAction implements Reporter {
       this.options.showTags = true;
     }
 
-    if (typeof options.report === "undefined") {
-      this.options.report = ["fail", "flaky", "pass", "skipped"];
+    if (typeof options.includeResults === "undefined") {
+      this.options.includeResults = ["fail", "flaky", "pass", "skipped"];
     }
 
     if (process.env.NODE_ENV === "development") {

src/index.ts

@@ -7,5 +7,5 @@ export interface GitHubActionOptions {
   showTags: boolean;
   showError?: boolean;
   quiet?: boolean;
-  report?: DisplayLevel[];
+  includeResults?: DisplayLevel[];
 }

src/models/GitHubActionOptions.ts

@@ -56,7 +56,7 @@ export const processResults = async (
             options.showAnnotations,
             options.showTags,
             !!options.showError,
-            options.report as DisplayLevel[]
+            options.includeResults as DisplayLevel[]
           );
 
           if (!content) {
@@ -76,7 +76,7 @@ export const processResults = async (
             options.showAnnotations,
             options.showTags,
             !!options.showError,
-            options.report as DisplayLevel[]
+            options.includeResults as DisplayLevel[]
           );
 
           if (tableRows.length !== 0) {

src/utils/processResults.ts

@@ -22,4 +22,14 @@ test.describe("Failing test", () => {
 
     expect((await logo.allInnerTexts()).join()).toBe("PYOD");
   });
+
+  test("Make screenshot fail", async () => {
+    await page.goto(
+      `https://www.eliostruyf.com?playwright=margin-left:10px;%20text-transform:%20lowercase;`
+    );
+
+    await expect(page).toHaveScreenshot("layout-mask.png", {
+      mask: [page.locator(`.sidebar__content`)],
+    });
+  });
 });