# @virtocommerce/protractor-jasmine2-html-reporter > HTML reporter for Jasmine2 and Protractor Latest version **1.1.1** (published 2018-05-16) · BSD-2-Clause license · 0 weekly downloads ## Install ```sh npm install @virtocommerce/protractor-jasmine2-html-reporter pnpm add @virtocommerce/protractor-jasmine2-html-reporter yarn add @virtocommerce/protractor-jasmine2-html-reporter bun add @virtocommerce/protractor-jasmine2-html-reporter ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.1 | | Published | 2018-05-16 | | First published | 2018-04-04 | | Weekly downloads | 0 | | License | BSD-2-Clause | | TypeScript types | none | | Module format | CommonJS | | Node | >=8.0.0 | | Dependencies | 7 | | Unpacked size | 43.3 KB | | Known vulnerabilities | 0 | | Install scripts | yes | | GitHub stars | 2 | | Author | Alejandro Asensio | | Maintainers | asvishnyakov, virto | | Keywords | jasmine, jasmine2, protractor, reporter, html, test, functional testing, screenshots, e2e, end2end, bdd | ## Links - npm: https://www.npmjs.com/package/@virtocommerce/protractor-jasmine2-html-reporter - Repository: https://github.com/VirtoCommerce/protractor-jasmine2-html-reporter - Homepage: https://github.com/VirtoCommerce/protractor-jasmine2-html-reporter#readme - Issues: https://github.com/VirtoCommerce/protractor-jasmine2-html-reporter/issues - npm.io page: https://npm.io/package/@virtocommerce/protractor-jasmine2-html-reporter ## Dependencies (7) - [hat](https://npm.io/package/hat.md) 0.0.3 - [lodash](https://npm.io/package/lodash.md) ^4.17.0 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0 - [imagemin](https://npm.io/package/imagemin.md) ^5.3.1 - [imagemin-pngout](https://npm.io/package/imagemin-pngout.md) ^3.0.0 - [imagemin-pngquant](https://npm.io/package/imagemin-pngquant.md) ^5.1.0 - [string.prototype.startswith](https://npm.io/package/string.prototype.startswith.md) ^0.2.0 ## Alternatives - [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads - [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads - [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads - [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads - [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads ## Recent versions - 1.1.1 (latest) — 2018-05-16 - 1.1.0 — 2018-05-16 - 1.0.2 — 2018-04-04 - 1.0.1 — 2018-04-04 - 1.0.0 — 2018-04-04 ## README # protractor-jasmine2-html-reporter [![npm version](https://badge.fury.io/js/%40virtocommerce%2Fprotractor-jasmine2-html-reporter.svg)](https://badge.fury.io/js/%40virtocommerce%2Fprotractor-jasmine2-html-reporter) HTML reporter for Jasmine2 and Protractor that will include screenshots of each test if you want. This work is inspired by: * [protractor-jasmine2-html-reporter](https://www.npmjs.com/package/protractor-jasmine2-html-reporter) from [@Kenzitron](https://github.com/Kenzitron) and its forks from [@dvs39](https://github.com/dvs39) and [Brent Pendergraft](https://github.com/penDerGraft) * [Protractor Jasmine 2 Screenshot Reporter](https://github.com/mlison/protractor-jasmine2-screenshot-reporter) from [@mslison](https://github.com/mlison) * [Jasmine Reporters](https://github.com/larrymyers/jasmine-reporters) from [@larrymyers](https://github.com/larrymyers) ## Usage The protractor-jasmine2-html-reporter is available via npm: $ npm install protractor-jasmine2-html-reporter --save-dev In your Protractor configuration file, register protractor-jasmine2-html-reporter in jasmine: 
var Jasmine2HtmlReporter = require('protractor-jasmine2-html-reporter');

exports.config = {
   // ...
   onPrepare: function() {
      jasmine.getEnv().addReporter(
        new Jasmine2HtmlReporter({
          savePath: 'target/screenshots'
        })
      );
   }
}
## Options ### Destination folder Output directory for created files. All screenshots and reports will be stored here. If the directory doesn't exist, it will be created automatically or otherwise cleaned before running the test suite. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/'
}));
Default folder: ./ ### Screenshots folder (optional) By default the screenshots are stored in a folder inside the default path If the directory doesn't exist, it will be created automatically or otherwise cleaned before running the test suite. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   screenshotsFolder: 'images'
}));
Default folder: screenshots ### Inline images (optional) Enabling inline images will create the html image tags with base64 encoding inline, removing the need to have a separate screenshot directory 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   inlineImages: true
}));
Default is false ### Optimize images (optional) Enabling images optimization will reduce size of images and html page. Two nested options supported and both required if image optimization used: - `lossy: boolean` - indicate should optimization be lossy or lossless - `level: number` - optimization level: the number in `[0..5]` range for lossy and `[0..2]` for lossless; lower is best compression, but worst quality (if lossy), higher is worst compression, but best quality (if lossy); max value is equivalent of uncompressed image. `PNGQuant` used for lossy compression (`quality: 50%` and `speed: 0` at `0` level, `100%` and `10` at `5`) and `PNGOut` used for lossless compression (`strategy: [2..4]` because `0` and `1` cause time out errors). 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   optimizeImages: false
}));
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   optimizeImages: { lossy: false, level: 0 }
}));
Default is { lossy: true, level: 1 } ### Screenshots url (optional) By default image url for screenshots is relative path. When this option is set, reporter will pick it for image url generation. When inlineImages option is enabled, this option will be ignored. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   screenshotsUrl: 'http://my-azure-blob-storage/screenshots-for-tests'
}));
Default value: '' ### Take screenshots (optional) When this option is enabled, reporter will create screenshots for specs. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   takeScreenshots: false
}));
Default is true ### Take screenshots only on failure (optional) - (NEW) This option allows you to choose if create screenshots always or only when failures. If you disable screenshots, obviously this option will not be taken into account. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   takeScreenshots: true,
   takeScreenshotsOnlyOnFailures: true
}));
Default is false (So screenshots are always generated) ### FixedScreenshotName (optional) Choose between random names and fixed ones. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   fixedScreenshotName: true
}));
Default is false ### FilePrefix (optional) Filename for html report. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   fileNamePrefix: 'Prefix'
}));
Default is nothing ### Consolidate and ConsolidateAll (optional) This option allow you to create a single file for each reporter. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   consolidate: false,
   consolidateAll: false
}));
Default is true ### CleanDestination (optional) This option, if false, will not delete the reports or screenshots before each test run. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   savePath: './test/reports/',
   cleanDestination: false
}));
Default is true ### showPassed (optional) This option, if false, will show only failures. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   showPassed: false
}));
Default is true ### fileName (optional) This will be the name used for the html file generated thanks to this tool. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   fileName: 'MyReportName'
}));
Default is htmlReport ### fileNameSeparator (optional) This will set the separator between filename elements, for example, prefix, sufix etc. 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   fileNameSeparator: '_'
}));
Default is - ### fileNamePrefix (optional) Prefix used before the name of the report 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   fileNamePrefix: ''
}));
Default is empty ### fileNameSuffix (optional) Suffix used after the name of the report 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   fileNameSuffix: ''
}));
Default is empty ### fileNameDateSuffix (optional) Datetime information to be added in the name of the report. This will be placed after the fileNameSuffix if it exists. The format is: YYYYMMDD HHMMSS,MILL -> 20161230 133323,728 
jasmine.getEnv().addReporter(new Jasmine2HtmlReporter({
   ....
   fileNameDateSuffix: true
}));
Default is false --- _Source: https://npm.io/package/@virtocommerce/protractor-jasmine2-html-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._