3.0 (#214)

* Feature/trim data (#169)

* remove unused arrays of collective tests

* only use uuids in suite collective test arrays

* remove derivable suite properties

* Feature/map suite (#170)

* map over suites to clean them; removing empty suites

* remove unused removeAllPropsFromObjExcept method

* fix/update tests

* Fix options handling (#194)

* Remove unused option

* Remove deprecated enableTestCode option

* Simplify options handling

Only handle options that pertain to the reporter and pass through all others as is. No longer rely on marge for base config.

* Update tests

* Documentation (#195)

* Update documentation for 3.0

* Add html option (#196)

* Update done function to handle when one or no files generated (#201)

* Update deps (#211)

* Update deps

* eslint: reorder rules

* eslint: update dep; fix lint

* Use local lib for functional tests

* Update cleanCode regex to handle async functions (#212)

* Docs (#213)

* changelog: reformat links

* package.json: bump major version; bump marge dep

* changelog: add 3.0.0 release notes

* npm scripts: add prepack script

.eslintrc

@@ -10,39 +10,41 @@
     "mocha": true
   },
   "rules": {
+    "array-bracket-spacing": [2, "always"],
     "arrow-parens": [2, "as-needed"],
     "brace-style": [2, "1tbs"],
+    "camelcase": 0,
+    "comma-dangle": [2, "never"],
     "comma-style": [2, "last"],
     "curly": [2, "multi-line"],
-    "quotes": [2, "single"],
-    "camelcase": 0,
-    "no-debugger": 2,
-    "no-undef": 2,
-    "no-underscore-dangle": 0,
-    "no-mixed-requires": 0,
-    "max-len": [1, 120, 2, {ignoreComments: true}],
-    "quote-props": [1, "consistent-as-needed"],
-    "no-cond-assign": [2, "except-parens"],
-    "radix": 0,
-    "space-infix-ops": 0,
-    "no-unused-vars": [1, {"vars": "local", "args": "none"}],
     "default-case": 0,
-    "no-param-reassign": 0,
-    "comma-dangle": [2, "never"],
-    "indent": [2, 2],
-    "object-curly-spacing": [2, "always"],
-    "array-bracket-spacing": [2, "always"],
     "func-names": 0,
-    "no-else-return": 0,
+    "global-require": 0,
+    "id-length": 0,
+    "import/no-extraneous-dependencies": 0,
+    "import/no-unresolved": 0,
+    "indent": [2, 2],
+    "max-len": [1, 120, 2, {ignoreComments: true}],
+    "no-cond-assign": [2, "except-parens"],
+    "no-confusing-arrow": 0,
     "no-console": 0,
-    "no-throw-literal": 0,
+    "no-debugger": 2,
+    "no-else-return": 0,
+    "no-mixed-requires": 0,
+    "no-param-reassign": 0,
     "no-plusplus": [2, { "allowForLoopAfterthoughts": true }],
-    "id-length": 0,
+    "no-throw-literal": 0,
+    "no-undef": 2,
+    "no-underscore-dangle": 0,
     "no-unused-expressions": 0,
-    "no-confusing-arrow": 0,
+    "no-unused-vars": [1, {"vars": "local", "args": "none"}],
+    "object-curly-newline": 0,
+    "object-curly-spacing": [2, "always"],
+    "prefer-destructuring": 0,
+    "quote-props": [1, "consistent-as-needed"],
+    "quotes": [2, "single"],
+    "radix": 0,
     "semi": [1, "always"],
-    "global-require": 0,
-    "import/no-unresolved": 0,
-    "import/no-extraneous-dependencies": 0
+    "space-infix-ops": 0
   }
 }

CHANGELOG.md

@@ -1,51 +1,69 @@
-# Changelog
+# mochawesome changelog
 
-### [2.3.1](https://github.com/adamgruber/mochawesome/releases/tag/2.3.1)
+## [3.0.0] / 2017-11-30
+This release is in tandem with and requires mochawesome-report-generator >= 3.0.0.
+
+### Added
+- New option: `html`. Allows user to specify whether or not to generate the HTML report. Defaults to `true`.
+
+### Changed
+- **BREAKING:** This release features a trimmed-down data output that removes properties that are not necessary for the report generation. This change will only affect things that consume the JSON output and does not affect usage of the reporter itself.
+
+- Suites are now cleaned by mapping over them instead of a breadth-first traversal
+
+- Options handling was overhauled and greatly simplified. The reporter will only concern itself with options directly related to the reporter. All other options are passed through to the report generator as-is.
+
+- Updated the `done` function to display better output when only one or no files have been generated.
+
+### Removed
+- `enableTestCode` option was deprecated as of 2.0.3 and has been removed. Use `enableCode` instead.
+
+### [2.3.1]
 - Fixes an issue where generator functions were not displayed properly [#188](https://github.com/adamgruber/mochawesome/pull/188) (@APshenkin)
 
-### [2.3.0](https://github.com/adamgruber/mochawesome/releases/tag/2.3.0)
+### [2.3.0]
 - Added `showHooks` option [#168](https://github.com/adamgruber/mochawesome/pull/168)
 - Support mocha's `--inline-diffs` option [#167](https://github.com/adamgruber/mochawesome/pull/167)
 - Normalize error objects for consistent display [#166](https://github.com/adamgruber/mochawesome/pull/166)
 - Bumped mochawesome-report-generator dependency to 2.2.0
 
-### [2.2.1](https://github.com/adamgruber/mochawesome/releases/tag/2.2.1)
+### [2.2.1]
 - Separated out before and after hooks
 - Bumped mochawesome-report-generator dependency to 2.1.0
 
-### [2.2.0](https://github.com/adamgruber/mochawesome/releases/tag/2.2.0)
+### [2.2.0]
 - Enable using `addContext` in `beforeEach` and `afterEach` test hooks
 - Fix a bug where you could pass an object with empty title string to `addContext`
 - Allow a context value of `undefined` to be displayed in the report
 
-### [2.1.0](https://github.com/adamgruber/mochawesome/releases/tag/2.1.0)
+### [2.1.0]
 - Added new options: `overwrite` and `timestamp`
 
-### [2.0.5](https://github.com/adamgruber/mochawesome/releases/tag/2.0.5)
+### [2.0.5]
 - Fix `UnhandledPromiseRejectionWarning` error when calling nonexistant `exit` function
 - Limit files included in package
 
-### [2.0.4](https://github.com/adamgruber/mochawesome/releases/tag/2.0.4)
+### [2.0.4]
 - Better handling of different coding styles in test code. [#98](https://github.com/adamgruber/mochawesome/issues/98)
 - Separate utility functions from main reporter code for better test coverage
 - Bump `mochawesome-report-generator` and `fs-extra` packages
 
-### [2.0.3](https://github.com/adamgruber/mochawesome/releases/tag/2.0.3)
+### [2.0.3]
 - Fixed [#126](https://github.com/adamgruber/mochawesome/issues/126)
 - Fix default options handling
 - Add `enableCode` option to be consistent with mochawesome-report-generator options
 - Deprecate `enableTestCode` option
 - Add `dev` option for testing
 
-### [2.0.2](https://github.com/adamgruber/mochawesome/releases/tag/2.0.2)
+### [2.0.2]
 - Fixed [#111](https://github.com/adamgruber/mochawesome/issues/111)
 
-### [2.0.1](https://github.com/adamgruber/mochawesome/releases/tag/2.0.1)
+### [2.0.1]
 - Fixed an issue where `reportFilename` was not propagated to `config` object
 - Updated handling of `reportDir` option to allow relative paths
 - Bumped mochawesome-report-generator dependency (requires 1.0.3 or higher)
 
-## [2.0.0](https://github.com/adamgruber/mochawesome/releases/tag/2.0.0)
+## [2.0.0]
 - Moved report generation to mochawesome-report package
 - Updated dependencies
 - Switched from jshint to eslint
@@ -59,60 +77,60 @@
 **Breaking Changes**
 - `reportName` option changed to `reportFilename`
 
-### [1.5.4](https://github.com/adamgruber/mochawesome/releases/tag/1.5.4)
+### [1.5.4]
 - Run pending tests thru `cleanTest` function. Fixes possible scenario where a pending test with a large amount of text could cause node to run out of memory. See [#94](https://github.com/adamgruber/mochawesome/issues/94)
 
-### [1.5.3](https://github.com/adamgruber/mochawesome/releases/tag/1.5.3)
+### [1.5.3]
 - Fixed build issues on Windows. See [#84](https://github.com/adamgruber/mochawesome/pull/84)
 
-### [1.5.2](https://github.com/adamgruber/mochawesome/releases/tag/1.5.2)
+### [1.5.2]
 - Updated mocha peerDependency to allow any version
 
-### [1.5.1](https://github.com/adamgruber/mochawesome/releases/tag/1.5.1)
+### [1.5.1]
 - Added missing LICENSE.md file
 
-### [1.5.0](https://github.com/adamgruber/mochawesome/releases/tag/1.5.0)
+### [1.5.0]
 - Moved mocha to peerDependencies and devDependencies and fixed it to `~2`. See [#69](https://github.com/adamgruber/mochawesome/issues/69)
 
-### [1.4.0](https://github.com/adamgruber/mochawesome/releases/tag/1.4.0)
+### [1.4.0]
 - Added slide-over navigation menu for quickly jumping to a test suite. See [#49](https://github.com/adamgruber/mochawesome/issues/49)
 
-### [1.3.5](https://github.com/adamgruber/mochawesome/releases/tag/1.3.5)
+### [1.3.5]
 - Removed extra slash in `@font-path` LESS variable. See [#53](https://github.com/adamgruber/mochawesome/issues/53)
 
-### [1.3.4](https://github.com/adamgruber/mochawesome/releases/tag/1.3.4)
+### [1.3.4]
 - Added option to auto open report. Also fixed an issue with boolean options. See [#44](https://github.com/adamgruber/mochawesome/issues/44)
 
-### [1.3.3](https://github.com/adamgruber/mochawesome/releases/tag/1.3.3)
+### [1.3.3]
 - Added support for creating custom dir where the parent dir(s) may not exist yet. See [#40](https://github.com/adamgruber/mochawesome/issues/40)
 
-### [1.3.2](https://github.com/adamgruber/mochawesome/releases/tag/1.3.2)
+### [1.3.2]
 - Removed `allHooks` array since it was not being used and could lead to an issue where node runs out of memory while rendering the template. See [#33](https://github.com/adamgruber/mochawesome/issues/33)
 
-### [1.3.1](https://github.com/adamgruber/mochawesome/releases/tag/1.3.1)
+### [1.3.1]
 - Update copyright in template
 
-### [1.3.0](https://github.com/adamgruber/mochawesome/releases/tag/1.3.0)
+### [1.3.0]
 - Changes to support mocha 2.4.0 and later (fixes empty code blocks). See [#29](https://github.com/adamgruber/mochawesome/issues/29)
 
-### [1.2.2](https://github.com/adamgruber/mochawesome/releases/tag/1.2.2)
+### [1.2.2]
 - Added option to generate report with all assets inlined. See [#26](https://github.com/adamgruber/mochawesome/issues/26)
 
-### [1.2.1](https://github.com/adamgruber/mochawesome/releases/tag/1.2.1)
+### [1.2.1]
 - Reset `totalTestsRegistered` when reporter is run. [PR #21](https://github.com/adamgruber/mochawesome/pull/21)
 
-### [1.2.0](https://github.com/adamgruber/mochawesome/releases/tag/1.2.0)
+### [1.2.0]
 - Enhancement: custom report title option. Closes [#11](https://github.com/adamgruber/mochawesome/issues/11)
 - Fixed indentation in code block and stack traces
 
-### [1.1.2](https://github.com/adamgruber/mochawesome/releases/tag/1.1.2)
+### [1.1.2]
 - Fixes [#10](https://github.com/adamgruber/mochawesome/issues/10)
 
-### [1.1.1](https://github.com/adamgruber/mochawesome/releases/tag/1.1.0)
+### [1.1.1]
 - Add filter icon in summary for better visibility (Completely new idea and not at all in response to [this](https://github.com/adamgruber/mochawesome/issues/5))
 - Change util.print to console.log due to [deprecation](https://github.com/joyent/node/blob/master/doc/api/util.markdown#user-content-utilprint)
 
-### [1.1.0](https://github.com/adamgruber/mochawesome/releases/tag/1.1.0)
+### [1.1.0]
 - Add support for options
   - custom report directory
   - custom report filename
@@ -121,10 +139,42 @@
 ### 1.0.1 - 1.0.5
 - Bugfixes
 
-## [1.0.0](https://github.com/adamgruber/mochawesome/releases/tag/1.0.0)
+## [1.0.0]
 - Redesigned report
 - Mobile friendly
 - Complete refactor of client-side script
 - Custom builds of vendor scripts
 - Custom font-icon set
 - All fonts are now local to the report
+
+[3.0.0]: https://github.com/adamgruber/mochawesome/compare/2.3.1...3.0.0
+[2.3.1]: https://github.com/adamgruber/mochawesome/compare/2.3.0...2.3.1
+[2.3.0]: https://github.com/adamgruber/mochawesome/compare/2.2.1...2.3.0
+[2.2.1]: https://github.com/adamgruber/mochawesome/compare/2.2.0...2.2.1
+[2.2.0]: https://github.com/adamgruber/mochawesome/compare/2.1.0...2.2.0
+[2.1.0]: https://github.com/adamgruber/mochawesome/compare/2.0.5...2.1.0
+[2.0.5]: https://github.com/adamgruber/mochawesome/compare/2.0.4...2.0.5
+[2.0.4]: https://github.com/adamgruber/mochawesome/compare/2.0.3...2.0.4
+[2.0.3]: https://github.com/adamgruber/mochawesome/compare/2.0.2...2.0.3
+[2.0.2]: https://github.com/adamgruber/mochawesome/compare/2.0.1...2.0.2
+[2.0.1]: https://github.com/adamgruber/mochawesome/compare/2.0.0...2.0.1
+[2.0.0]: https://github.com/adamgruber/mochawesome/compare/1.5.4...2.0.0
+[1.5.4]: https://github.com/adamgruber/mochawesome/compare/1.5.3...1.5.4
+[1.5.3]: https://github.com/adamgruber/mochawesome/compare/1.5.2...1.5.3
+[1.5.2]: https://github.com/adamgruber/mochawesome/compare/1.5.1...1.5.2
+[1.5.1]: https://github.com/adamgruber/mochawesome/compare/1.5.0...1.5.1
+[1.5.0]: https://github.com/adamgruber/mochawesome/compare/1.4.0...1.5.0
+[1.4.0]: https://github.com/adamgruber/mochawesome/compare/1.3.5...1.4.0
+[1.3.5]: https://github.com/adamgruber/mochawesome/compare/1.3.4...1.3.5
+[1.3.4]: https://github.com/adamgruber/mochawesome/compare/1.3.3...1.3.4
+[1.3.3]: https://github.com/adamgruber/mochawesome/compare/1.3.2...1.3.3
+[1.3.2]: https://github.com/adamgruber/mochawesome/compare/1.3.1...1.3.2
+[1.3.1]: https://github.com/adamgruber/mochawesome/compare/1.3.0...1.3.1
+[1.3.0]: https://github.com/adamgruber/mochawesome/compare/1.2.2...1.3.0
+[1.2.2]: https://github.com/adamgruber/mochawesome/compare/1.2.1...1.2.2
+[1.2.1]: https://github.com/adamgruber/mochawesome/compare/1.2.0...1.2.1
+[1.2.0]: https://github.com/adamgruber/mochawesome/compare/1.1.2...1.2.0
+[1.1.2]: https://github.com/adamgruber/mochawesome/compare/1.1.1...1.1.2
+[1.1.1]: https://github.com/adamgruber/mochawesome/compare/1.1.0...1.1.1
+[1.1.0]: https://github.com/adamgruber/mochawesome/compare/1.0.0...1.1.0
+[1.0.0]: https://github.com/adamgruber/mochawesome/compare/0.3.3...1.0.0