documentary - npm Package Compare versions

Comparing version 1.6.0 to 1.6.1

build/lib/rules/example.js

@@ -10,11 +10,30 @@ "use strict";
 
-var _wrote = require("wrote");
-
 var _path = require("path");
 
+var _fs = require("fs");
+
+var _catchment = _interopRequireDefault(require("catchment"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 const LOG = (0, _util.debuglog)('doc');
 
+const read = async source => {
+  const rs = (0, _fs.createReadStream)(source);
+  const data = await new Promise(async (r, j) => {
+    const {
+      promise
+    } = new _catchment.default({
+      rs
+    });
+    rs.on('error', j);
+    const res = await promise;
+    r(res);
+  });
+  return data;
+};
+
 const replacer = async (match, source, from, to, type) => {
   try {
-    let f = await (0, _wrote.read)(source);
+    let f = await read(source);
     f = f.trim();
@@ -21,0 +40,0 @@

CHANGELOG.md

 ## 22 June 2018
 
+### 1.6.1
+
+- [dep] Remove `wrote`, implement simple file read.
+- [fix] `skipLevelOne=true` in documentation.
+
 ### 1.6.0
@@ -4,0 +9,0 @@

package.json

 {
   "name": "documentary",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "A library to manage documentation, such as README, usage, man pages and changelog.",
@@ -60,5 +60,4 @@ "main": "build",
     "restream": "2.1.0",
-    "spawncommand": "2.0.1",
-    "wrote": "1.4.0"
+    "spawncommand": "2.0.1"
   }
 }

README.md

@@ -35,3 +35,3 @@ # documentary
   * [`Toc` Type](#toc-type)
-  * [`constructor(config?: object): Toc`](#constructorconfig-skiplevelone-boolean--false-toc)
+  * [`constructor(config?: object): Toc`](#constructorconfig-skiplevelone-boolean--true-toc)
 
@@ -272,3 +272,3 @@ ## Installation & Usage
 
-### `constructor(`<br/>&nbsp;&nbsp;`config?: {`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`skipLevelOne?: boolean = false,`<br/>&nbsp;&nbsp;`},`<br/>`): Toc`
+### `constructor(`<br/>&nbsp;&nbsp;`config?: {`<br/>&nbsp;&nbsp;&nbsp;&nbsp;`skipLevelOne?: boolean = true,`<br/>&nbsp;&nbsp;`},`<br/>`): Toc`
 
@@ -275,0 +275,0 @@ Create a new instance of a `Toc` stream.

No alert changes

Improved metrics

Total package byte prevSize

74607

increased by1.69%

Dependency count

5

decreased by-16.67%

Lines of code

709

increased by2.31%

Worsened metrics

Number of low supply chain risk alerts

4

increased by33.33%

Dependency changes

• - Removedwrote@1.4.0

• - Removederotic@0.2.0(transitive)

• - Removedmakepromise@1.1.1(transitive)

• - Removedrestream@1.2.0(transitive)

• - Removedwrote@1.4.0(transitive)