speed-measure-webpack-plugin - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "speed-measure-webpack-plugin",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Measure + analyse the speed of your webpack loaders and plugins",
@@ -8,3 +8,4 @@ "main": "index.js",
     "test": "jest",
-    "functional-test": "lerna bootstrap && lerna run prepare && lerna run test && lerna run cleanup"
+    "functional-test": "lerna bootstrap && lerna run prepare && lerna run test && lerna run cleanup",
+    "documentation-test": "alex ./README.md && write-good ./README.md"
   },
@@ -31,5 +32,7 @@ "repository": {
   "devDependencies": {
+    "alex": "^5.1.0",
     "jest": "^22.4.2",
     "lerna": "^2.9.0",
-    "prettier": "1.10.2"
+    "prettier": "1.10.2",
+    "write-good": "^0.11.3"
   },
@@ -36,0 +39,0 @@ "dependencies": {

README.md

@@ -74,3 +74,3 @@ <div align="center">
 
-Options are (optionally) passed in to the constructor
+Pass these into the constructor, as an object:
 
@@ -86,4 +86,6 @@ ```javascript
 
-If truthy, this plugin does nothing at all. It is recommended to set this with something similar to `{ disable: !process.env.MEASURE }` to allow opt-in measurements with a `MEASURE=true npm run build`
+If truthy, this plugin does nothing at all.
 
+`{ disable: !process.env.MEASURE }` allows opt-in measurements with `MEASURE=true npm run build`.
+
 ### `options.outputFormat`
@@ -99,3 +101,3 @@
  * `"humanVerbose"` - produces a more verbose version of the human readable output
- * If a function, it will call the function with the JSON blob being the first parameter, and just the response of the function as the output
+ * If a function, it will call the function with the JSON blob, and output the response
 
@@ -139,10 +141,10 @@ ### `options.outputTarget`
 
-If truthy, this plugin will attempt to break down the loader timing data to give per-loader timing information.
+By default, SMP measures loaders in groups. If truthy, this plugin will give per-loader timing information.
 
-Points of note that the following loaders will have inaccurate results in this mode:
+This flag is _experimental_. Some loaders will have inaccurate results:
 
- * loaders using separate processes (e.g. `thread-loader`) - these make it difficult to get timing information on the subsequent loaders, as they're not attached to the main thread
- * loaders emitting file output (e.g. `file-loader`) - the time taken in outputting the actual file is not included in the running time of the loader
+ * loaders using separate processes (e.g. `thread-loader`)
+ * loaders emitting file output (e.g. `file-loader`)
 
-These are restrictions from technical limitations - ideally we would find solutions to these problems before removing the _(experimental)_ flag on this options
+We will find solutions to these issues before removing the _(experimental)_ flag on this option.
 
@@ -149,0 +151,0 @@ ## License

No alert changes

Improved metrics

Number of lines in readme file

150

increased by1.35%

Worsened metrics

Total package byte prevSize

251970

decreased by-0.1%

Dev dependency count

5

increased by66.67%

No dependency changes