karma-jasmine-diff-reporter - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "karma-jasmine-diff-reporter",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Diff and pretty print for failed tests",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -8,2 +8,6 @@ karma-jasmine-diff-reporter [![Build status](https://travis-ci.org/mradionov/karma-jasmine-diff-reporter.svg?branch=master)](https://travis-ci.org/mradionov/karma-jasmine-diff-reporter)
 
+## Important
+
+The goal of the reporter is to add user-friendly diff highlighting for complex nested structures. Jasmine 2.6 introduced it's own solution for such a case and now has it out-of-the-box. Reporter is relying on the actual console output and since it has changed, reporter can't work correctly any more. If you are fine with Jasmine 2.6+ output, then the reporter won't be very useful. If you want to use the reporter instead of built-in Jasmine solution, make sure to set an option `legacy: true` in reporter options ([docs](#legacy)), which will enforce the console output to Jasmine prior 2.6, so the reporter could work with it and highlight the results.
+
 ## Install
@@ -38,2 +42,16 @@
 
+If you have `plugins` option overriden, make sure to add the reporter in there too ([Karma/Loading Plugins](http://karma-runner.github.io/1.0/config/plugins.html))
+
+```js
+// karma.conf.js
+module.exports = function(config) {
+  config.set({
+    reporters: ['jasmine-diff'],
+    plugins: [
+      'karma-jasmine-diff-reporter'
+    ]
+  });
+};
+```
+
 ## Options
@@ -132,3 +150,3 @@
 
-### legacy
+#### legacy
 
@@ -135,0 +153,0 @@ Jasmine 2.6 introduced built-in diffs for objects. Reporter can't work with those diffs at the moment, so they are simply displayed without any highlights.

No alert changes

Improved metrics

Total package byte prevSize

109340

increased by0.94%

Number of lines in readme file

192

increased by10.34%

No dependency changes