Release/1.1.24 (#55)

* small doco tweak

* fix eslint complaints + version bump

.eslintrc.json

@@ -24,6 +24,9 @@
          "no-undef": 0,
          "no-use-before-define": 0,
          "operator-linebreak": ["error", "before"]
-    }
+    },
+    "ignorePatterns": [
+        "*.d.ts"
+    ]
 }
 

README.md

@@ -180,7 +180,7 @@ Same as **layout** above, but asynchronous in that it returns a promise.
 ### **maxNumberOfFailuresToShow**
 Limits the number of failures shown in the Slack message, defaults to 10.
 ### **separateFlaky**
-Don't consider flaky tests as passed, instead output them separately. Flaky tests are tests that passed but not on the first try.
+Don't consider flaky tests as passed, instead output them separately. Flaky tests are tests that passed but not on the first try.  This defaults to `false` but it is highly recommended that you switch this on.
 ### **slackOAuthToken**
 Instead of providing an environment variable `SLACK_BOT_USER_OAUTH_TOKEN` you can specify the token in the config in the `slackOAuthToken` field.
 ### **slackLogLevel** (default LogLevel.DEBUG)

package.json

@@ -26,10 +26,11 @@
     "prettier": "prettier --write --loglevel warn \"**/**/*.ts\"",
     "pw": "nyc playwright test && nyc report --reporter=lcov",
     "build": "tsc -p ./tsconfig.json",
-    "lint": "npx eslint . --ext .ts"
+    "lint": "npx eslint . --ext .ts",
+    "lint-fix": "npx eslint . --ext .ts --fix"
   },
   "name": "playwright-slack-report",
-  "version": "1.1.23",
+  "version": "1.1.24",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "[email protected]:ryanrosello-og/playwright-slack-report.git",

src/ResultsParser.ts

@@ -5,7 +5,9 @@
 /* eslint-disable class-methods-use-this */
 /* eslint-disable no-param-reassign */
 
-import { failure, flaky, pass, SummaryResults } from '.';
+import {
+  failure, flaky, pass, SummaryResults,
+} from '.';
 
 /* eslint-disable no-restricted-syntax */
 export type testResult = {

src/SlackReporter.ts

@@ -52,9 +52,7 @@ class SlackReporter implements Reporter {
   onBegin(fullConfig: FullConfig, suite: Suite): void {
     this.suite = suite;
     this.logs = [];
-    const slackReporterConfig = fullConfig.reporter.filter((f) =>
-      f[0].toLowerCase().includes('slackreporter'),
-    )[0][1];
+    const slackReporterConfig = fullConfig.reporter.filter((f) => f[0].toLowerCase().includes('slackreporter'))[0][1];
     if (fullConfig.projects.length === 0) {
       this.browsers = [];
     } else {
@@ -73,8 +71,8 @@ class SlackReporter implements Reporter {
       this.customLayout = slackReporterConfig.layout;
       this.customLayoutAsync = slackReporterConfig.layoutAsync;
       this.slackChannels = slackReporterConfig.channels;
-      this.maxNumberOfFailuresToShow =
-        slackReporterConfig.maxNumberOfFailuresToShow || 10;
+      this.maxNumberOfFailuresToShow
+        = slackReporterConfig.maxNumberOfFailuresToShow || 10;
       this.slackOAuthToken = slackReporterConfig.slackOAuthToken || undefined;
       this.slackWebHookUrl = slackReporterConfig.slackWebHookUrl || undefined;
       this.disableUnfurl = slackReporterConfig.disableUnfurl || false;
@@ -104,11 +102,10 @@ class SlackReporter implements Reporter {
     resultSummary.meta = this.meta;
     const maxRetry = Math.max(...resultSummary.tests.map((o) => o.retry));
     if (
-      this.sendResults === 'on-failure' &&
-      resultSummary.tests.filter(
-        (z) =>
-          (z.status === 'failed' || z.status === 'timedOut') &&
-          z.retry === maxRetry,
+      this.sendResults === 'on-failure'
+      && resultSummary.tests.filter(
+        (z) => (z.status === 'failed' || z.status === 'timedOut')
+          && z.retry === maxRetry,
       ).length === 0
     ) {
       this.log('⏩ Slack reporter - no failures found');
@@ -173,9 +170,9 @@ class SlackReporter implements Reporter {
     }
 
     if (
-      !this.slackWebHookUrl &&
-      !this.slackOAuthToken &&
-      !process.env.SLACK_BOT_USER_OAUTH_TOKEN
+      !this.slackWebHookUrl
+      && !this.slackOAuthToken
+      && !process.env.SLACK_BOT_USER_OAUTH_TOKEN
     ) {
       return {
         okToProceed: false,
@@ -185,8 +182,8 @@ class SlackReporter implements Reporter {
     }
 
     if (
-      this.slackWebHookUrl &&
-      (process.env.SLACK_BOT_USER_OAUTH_TOKEN || this.slackOAuthToken)
+      this.slackWebHookUrl
+      && (process.env.SLACK_BOT_USER_OAUTH_TOKEN || this.slackOAuthToken)
     ) {
       return {
         okToProceed: false,
@@ -196,8 +193,8 @@ class SlackReporter implements Reporter {
     }
 
     if (
-      !this.sendResults ||
-      !['always', 'on-failure', 'off'].includes(this.sendResults)
+      !this.sendResults
+      || !['always', 'on-failure', 'off'].includes(this.sendResults)
     ) {
       return {
         okToProceed: false,
@@ -221,8 +218,8 @@ class SlackReporter implements Reporter {
     }
 
     if (
-      this.customLayoutAsync &&
-      typeof this.customLayoutAsync !== 'function'
+      this.customLayoutAsync
+      && typeof this.customLayoutAsync !== 'function'
     ) {
       return {
         okToProceed: false,