Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamgruber committed Dec 19, 2016
1 parent e57c0f7 commit 0a45aeb
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 24 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Changelog

###1.0.0-alpha
- Initial alpha release
###1.0.0
- Initial release
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
**All bug reports and problem issues require example code**. In addition please submit the following:

- Platform you are running on
- The version of mochawesome-report you are using
- How you are using mochawesome-report (via CLI, inside mochawesome, or some other means)
- The version of mochawesome/mochawesome-report-generator you are using
- How you are using mochawesome-report-generator (via CLI, inside mochawesome, or some other means)

Providing a sample test is the best way to get your issue addressed and without it your issue may be closed.
You must provide a clear and simple way to reproduce the issue.
Expand Down
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
mochawesome-report
==================
[![npm](https://img.shields.io/npm/v/mochawesome-report.svg?style=flat-square)](http://www.npmjs.com/package/mochawesome-report) [![Build Status](https://img.shields.io/travis/adamgruber/mochawesome-report/master.svg?style=flat-square)](https://travis-ci.org/adamgruber/mochawesome-report) [![Code Climate](https://img.shields.io/codeclimate/github/adamgruber/mochawesome-report.svg?style=flat-square)](https://codeclimate.com/github/adamgruber/mochawesome-report)
mochawesome-report-generator (marge)
============================
[![npm](https://img.shields.io/npm/v/mochawesome-report-generator.svg?style=flat-square)](http://www.npmjs.com/package/mochawesome-report-generator) [![Build Status](https://img.shields.io/travis/adamgruber/mochawesome-report-generator/master.svg?style=flat-square)](https://travis-ci.org/adamgruber/mochawesome-report-generator) [![Code Climate](https://img.shields.io/codeclimate/github/adamgruber/mochawesome-report-generator.svg?style=flat-square)](https://codeclimate.com/github/adamgruber/mochawesome-report-generator)

mochawesome-report is the counterpart to a [mochawesome][2], a custom reporter for use with the Javascript testing framework, [mocha][1]. This package takes the JSON output from [mochawesome][2] and generates a full fledged HTML/CSS report that helps visualize your test suites.
**marge** (**m**och**a**wesome-**r**eport-**ge**nerator) is the counterpart to [mochawesome][2], a custom reporter for use with the Javascript testing framework, [mocha][1]. Marge takes the JSON output from [mochawesome][2] and generates a full fledged HTML/CSS report that helps visualize your test suites.

##Features
- All-new redesigned and streamlined report
- At-a-glance stats including pass percentage
- Beautiful charts
- Support for nested `describe`s
Expand All @@ -13,41 +14,43 @@ mochawesome-report is the counterpart to a [mochawesome][2], a custom reporter f
- Quick navigation menu
- Review test code inline
- Stack trace for failed tests
- Inline diffs for actual vs expected results
- Responsive and mobile-friendly
- Custom report [options](#options)
- Supports displaying additional test context
- Custom report [options](#cli-options)
- Offline viewing
- CLI for generating reports independent of [mochawesome][2]

##Browser Support
Tested to work in Chrome. *Should* work in any modern web browser including IE9+.
mochawesome-report generates a self-contained report that can be viewed offline.
**marge** generates a self-contained report that can be viewed offline.

##Sample Report

<img src="./docs/mochawesome-1_4.png" alt="Mochawesome Report" width="75%" />
<img src="./docs/mochawesome-menu-1_4.png" alt="Mochawesome Report Menu" width="75%" />
<img src="./docs/marge-report-1.0.0.png" alt="Mochawesome Report" width="75%" />
<img src="./docs/marge-report-menu-1.0.0.png" alt="Mochawesome Report Menu" width="75%" />


##Usage

**via CLI**

Install mochawesome-report package
Install mochawesome-report-generator package
```bash
npm install -g mochawesome-report
npm install -g mochawesome-report-generator
```

Run the command
```bash
mareport [test-output.json] <options>
marge [test-output.json] <options>
```

**via Mochawesome reporter**

See mochawesome [docs][2].

##Output
mochawesome-report generates the following inside your project directory:
**marge** generates the following inside your project directory:
```
mochawesome-report/
├── assets
Expand All @@ -66,7 +69,7 @@ mochawesome-report/

##CLI Options

mochawesome-report can be configured via command line flags
**marge** can be configured via command line flags

Flag | Type | Default | Description
:--- | :--- | :------ | :----------
Expand Down
2 changes: 1 addition & 1 deletion bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const mareport = require('./cli-main');

/* Report Options
* @property {string} reportFilename Filename of report (default: mochawesome)
* @property {string} reportDir Path to save report to (default: cwd/mochawesome-reports)
* @property {string} reportDir Path to save report to (default: cwd/mochawesome-report)
* @property {string} reportTitle Title to use on the report (default: mochawesome)
* @property {string} reportPageTitle Title of the report document (default: mochawesome-report)
* @property {boolean} inlineAssets Should assets be inlined into HTML file (default: false)
Expand Down
Binary file added docs/marge-report-1.0.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/marge-report-menu-1.0.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mochawesome-report",
"version": "1.0.0-alpha.2",
"description": "Generates gorgeous HTML reports in Mocha.js from mochawesome reporter.",
"name": "mochawesome-report-generator",
"version": "1.0.0",
"description": "Generates gorgeous HTML reports from mochawesome reporter.",
"scripts": {
"lint": "eslint bin lib src/js src/components/**/*.js src/components/**/*.jsx test/**/*.js test/**/*.jsx",
"test": "cross-env UV_THREADPOOL_SIZE=100 BABEL_DISABLE_CACHE=1 NODE_ENV=test nyc $(npm bin)/mocha --require test/helper.js \"test/spec/**/*.test.+(js|jsx)\"",
Expand All @@ -19,19 +19,20 @@
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/adamgruber/mochawesome-report"
"url": "https://github.com/adamgruber/mochawesome-report-generator"
},
"keywords": [
"mochawesome",
"mocha",
"reporter",
"json",
"react"
"react",
"report generator"
],
"engine": "node >= 4",
"main": "lib/main.js",
"bin": {
"margen": "./bin/cli.js"
"marge": "./bin/cli.js"
},
"nyc": {
"sourceMap": false,
Expand Down

0 comments on commit 0a45aeb

Please sign in to comment.