allure-single-html-file-ts

Allure single HTML file builder for TypeScript

Tool to build allure generated folder into a single html file. Migrated to TypeScript from the JavaScript repo allure-single-html-file-js by Adrien Ruiz Gauder

What it's doing?

1. Migrates to TypeScript from allure-single-html-file-js
2. Reads contents of allure-generated folder
3. Creates server.js file, which has all the data files inside and code to start fake XHR server
4. Patches index.html file, so it's using server.js and sinon-9.2.4.js (Taken from here), and could be run in any browser without --allow-file-access-from-files parameter of Chrome browser
5. Creates file complete.html with all files built-in in a single file

Requirements

• Node (v16+)
• You need to have your allure report folder generated (allure generate './some/path/to/allure/reports/generated/folder')

Installation

npm install allure-single-html-file-ts

Run as console script

npx allure-single-html-file-ts ./some/path/to/allure/reports/generated/folder

Options

ALLURE_REPORT_SANITIZE_ANGLE_BRACKETS

If you set this environment variable to any value, then any angled brackets that appear in the content of the Allure Report (i.e "<" or ">") will be sanitized to "<" or ">"

If you don't add this environment variable, then the angled brackets won't be sanitized.

ALLURE_REPORT_SANITIZE_ANGLE_BRACKETS=1 npx allure-single-html-file-ts ./some/path/to/allure/generated/folder