@cucumber/html-formatter 22.3.0 → 23.1.0

package/src/CucumberHtmlStream.ts

@@ -1,7 +1,7 @@
-import * as messages from '@cucumber/messages'
-import fs from 'fs'
-import path from 'path'
-import { Readable, Transform, TransformCallback } from 'stream'
+import fs from 'node:fs'
+import path from 'node:path'
+import { type Readable, Transform, type TransformCallback } from 'node:stream'
+import type { Envelope } from '@cucumber/messages'
 
 export class CucumberHtmlStream extends Transform {
   private template: string | null = null
@@ -22,17 +22,17 @@ export class CucumberHtmlStream extends Transform {
     super({ objectMode: true })
   }
 
-  public _transform(
-    envelope: messages.Envelope,
-    encoding: string,
-    callback: TransformCallback
-  ): void {
+  public _transform(envelope: Envelope, _encoding: string, callback: TransformCallback): void {
     if (this.postMessageWritten) {
-      return callback(new Error('Stream closed'))
+      callback(new Error('Stream closed'))
+      return
     }
 
     this.writePreMessageUnlessAlreadyWritten((err) => {
-      if (err) return callback(err)
+      if (err) {
+        callback(err)
+        return
+      }
       this.writeMessage(envelope)
       callback()
     })
@@ -60,14 +60,10 @@ export class CucumberHtmlStream extends Transform {
               if (err) return callback(err)
               this.writeTemplateBetween('{{css}}', '{{custom_css}}', (err) => {
                 if (err) return callback(err)
-                this.writeTemplateBetween(
-                  '{{custom_css}}',
-                  '{{messages}}',
-                  (err) => {
-                    if (err) return callback(err)
-                    callback()
-                  }
-                )
+                this.writeTemplateBetween('{{custom_css}}', '{{messages}}', (err) => {
+                  if (err) return callback(err)
+                  callback()
+                })
               })
             })
           })
@@ -83,14 +79,10 @@ export class CucumberHtmlStream extends Transform {
         if (err) return callback(err)
         this.writeFile(this.jsPath, (err) => {
           if (err) return callback(err)
-          this.writeTemplateBetween(
-            '{{script}}',
-            '{{custom_script}}',
-            (err) => {
-              if (err) return callback(err)
-              this.writeTemplateBetween('{{custom_script}}', null, callback)
-            }
-          )
+          this.writeTemplateBetween('{{script}}', '{{custom_script}}', (err) => {
+            if (err) return callback(err)
+            this.writeTemplateBetween('{{custom_script}}', null, callback)
+          })
         })
       })
     })
@@ -110,34 +102,26 @@ export class CucumberHtmlStream extends Transform {
   ) {
     this.readTemplate((err, template) => {
       if (err) return callback(err)
-      if (!template)
-        return callback(new Error('template is required if error is missing'))
-      const beginIndex =
-        begin == null ? 0 : template.indexOf(begin) + begin.length
+      if (!template) return callback(new Error('template is required if error is missing'))
+      const beginIndex = begin == null ? 0 : template.indexOf(begin) + begin.length
       const endIndex = end == null ? template.length : template.indexOf(end)
       this.push(template.substring(beginIndex, endIndex))
       callback()
     })
   }
 
-  private readTemplate(
-    callback: (error?: Error | null, data?: string) => void
-  ) {
+  private readTemplate(callback: (error?: Error | null, data?: string) => void) {
     if (this.template !== null) {
       return callback(null, this.template)
     }
-    fs.readFile(
-      __dirname + '/index.mustache.html',
-      { encoding: 'utf-8' },
-      (err, template) => {
-        if (err) return callback(err)
-        this.template = template
-        return callback(null, template)
-      }
-    )
+    fs.readFile(`${__dirname}/index.mustache`, { encoding: 'utf-8' }, (err, template) => {
+      if (err) return callback(err)
+      this.template = template
+      return callback(null, template)
+    })
   }
 
-  private writeMessage(envelope: messages.Envelope) {
+  private writeMessage(envelope: Envelope) {
     if (!this.firstMessageWritten) {
       this.firstMessageWritten = true
     } else {

package/src/main.tsx

@@ -1,12 +1,7 @@
 import './styles.scss'
 
-import { Envelope } from '@cucumber/messages'
-import {
-  EnvelopesProvider,
-  Report,
-  UrlSearchProvider,
-} from '@cucumber/react-components'
-import React from 'react'
+import type { Envelope } from '@cucumber/messages'
+import { EnvelopesProvider, Report, UrlSearchProvider } from '@cucumber/react-components'
 import { createRoot } from 'react-dom/client'
 
 declare global {

package/test/acceptance.spec.ts

@@ -8,16 +8,14 @@ import { sync } from 'glob'
 
 import { CucumberHtmlStream } from '../src'
 
-const fixtures = sync(
-  `./node_modules/@cucumber/compatibility-kit/features/**/*.ndjson`
-)
+const fixtures = sync(`./node_modules/@cucumber/compatibility-kit/features/**/*.ndjson`)
 
 test.beforeAll(async () => {
   const outputDir = path.join(__dirname, './__output__')
 
   for (const fixture of fixtures) {
     const name = path.basename(fixture, '.ndjson')
-    const outputFile = path.join(outputDir, name + '.html')
+    const outputFile = path.join(outputDir, `${name}.html`)
 
     await pipeline(
       fs.createReadStream(fixture, { encoding: 'utf-8' }),
@@ -38,6 +36,6 @@ for (const fixture of fixtures) {
   test(`can render ${name}`, async ({ page }) => {
     await page.goto(`/${name}.html`)
     await page.waitForSelector('#report', { timeout: 3000 })
-    await expect(page).toHaveScreenshot(`${name}.png`)
+    await expect(page).toHaveScreenshot(`${name}.png`, { fullPage: true })
   })
 }

package/test/screenshot.css

@@ -1,4 +1,4 @@
 time,
-[data-testid='cucumber.summary.setup'] {
-  visibility: hidden !important;
+[data-testid="cucumber.summary.setup"] {
+  visibility: hidden;
 }

package/tsconfig.build.json

@@ -7,9 +7,5 @@
     "declarationMap": true,
     "noEmit": false
   },
-  "include": [
-    "src",
-    "test",
-    "package.json"
-  ]
+  "include": ["src", "test", "package.json"]
 }

package/tsconfig.json

@@ -12,14 +12,11 @@
     "strictNullChecks": true,
     "experimentalDecorators": true,
     "module": "CommonJS",
-    "lib": [
-      "ES6",
-      "dom"
-    ],
+    "lib": ["ES6", "dom"],
     "target": "ES6",
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
     "noEmit": true,
-    "jsx": "react"
+    "jsx": "react-jsx"
   }
 }

package/webpack.config.js

@@ -1,4 +1,4 @@
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin')
 
 module.exports = {
   entry: './dist/src/main.js',
@@ -13,18 +13,18 @@ module.exports = {
             options: {
               modules: {
                 auto: true,
-                namedExport: false
-              }
-            }
+                namedExport: false,
+              },
+            },
           },
-          'sass-loader'
+          'sass-loader',
         ],
-      }
+      },
     ],
   },
   plugins: [
     new MiniCssExtractPlugin({
-      filename: 'main.css'
-    })
-  ]
-};
+      filename: 'main.css',
+    }),
+  ],
+}

package/.prettierignore

@@ -1 +0,0 @@
-*.html

package/.prettierrc.json

@@ -1,5 +0,0 @@
-{
-	"trailingComma": "es5",
-	"singleQuote": true,
-	"semi": false
-}

package/eslint.config.mjs

@@ -1,78 +0,0 @@
-import { fixupConfigRules, fixupPluginRules } from "@eslint/compat";
-import react from "eslint-plugin-react";
-import _import from "eslint-plugin-import";
-import simpleImportSort from "eslint-plugin-simple-import-sort";
-import n from "eslint-plugin-n";
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default [...fixupConfigRules(compat.extends(
-    "eslint:recommended",
-    "plugin:react/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:import/typescript",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-)), {
-    plugins: {
-        react: fixupPluginRules(react),
-        import: fixupPluginRules(_import),
-        "simple-import-sort": simpleImportSort,
-        n,
-        "@typescript-eslint": fixupPluginRules(typescriptEslint),
-    },
-
-    languageOptions: {
-        globals: {
-            ...globals.browser,
-            ...globals.node,
-        },
-
-        parser: tsParser,
-        ecmaVersion: 5,
-        sourceType: "module",
-    },
-
-    settings: {
-        react: {
-            pragma: "React",
-            version: "detect",
-        },
-    },
-
-    rules: {
-        "import/no-cycle": "error",
-        "n/no-extraneous-import": "error",
-        "@typescript-eslint/ban-ts-ignore": "off",
-        "@typescript-eslint/ban-ts-comment": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/interface-name-prefix": "off",
-        "@typescript-eslint/member-delimiter-style": "off",
-        "@typescript-eslint/no-explicit-any": "error",
-        "@typescript-eslint/no-non-null-assertion": "error",
-        "simple-import-sort/imports": "error",
-        "simple-import-sort/exports": "error",
-        "react/prop-types": "off",
-    },
-}, {
-    files: ["test/**"],
-
-    rules: {
-        "@typescript-eslint/no-non-null-assertion": "off",
-    },
-}];