documentary - npm Package Compare versions

Comparing version 1.4.0 to 1.4.1

build/bin/index.js

@@ -8,3 +8,3 @@ #!/usr/bin/env node
 
-var _wrote = require("wrote");
+var _pedantry = _interopRequireDefault(require("pedantry"));
 
@@ -15,4 +15,2 @@ var _util = require("util");
 
-var _dirStream = _interopRequireDefault(require("../lib/dir-stream"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -42,3 +40,3 @@
 
-const doc = async (source, output, toc) => {
+const doc = async (source, output, justToc = false) => {
   if (!source) {
@@ -50,22 +48,12 @@ console.log('Please specify an input file.'); // print usage
 
+  const ls = (0, _fs.lstatSync)(source);
   let stream;
 
-  try {
-    const {
-      content
-    } = await (0, _wrote.readDirStructure)(source);
-    stream = (0, _dirStream.default)(source, content);
-  } catch (err) {
-    const {
-      code
-    } = err;
-
-    if (code == 'ENOTDIR') {
-      stream = (0, _fs.createReadStream)(source);
-    } else {
-      throw err;
-    }
+  if (ls.isDirectory()) {
+    stream = new _pedantry.default(source);
+  } else if (ls.isFile()) {
+    stream = (0, _fs.createReadStream)(source);
   }
 
-  await (0, _run.default)(stream, output, toc);
+  await (0, _run.default)(stream, output, justToc);
 };
@@ -82,3 +70,3 @@
     if (code == 'ENOENT') {
-      console.log('File %s does not exist', _source);
+      console.log('File %s does not exist.', _source);
       process.exit(2);
@@ -85,0 +73,0 @@ }

build/bin/run.js

@@ -32,7 +32,7 @@ "use strict";
  * @param {string} [out] Path to the output file.
- * @param {boolean} [toc] Just print the TOC.
+ * @param {boolean} [justToc] Just print the TOC.
  */
 
 
-async function run(stream, out, toc) {
+async function run(stream, out, justToc) {
   const pt = new _stream.PassThrough();
@@ -43,3 +43,3 @@ pt.pause();
 
-  if (toc) {
+  if (justToc) {
     console.log(t);
@@ -46,0 +46,0 @@ process.exit();

build/lib/rules/index.js

@@ -6,3 +6,3 @@ "use strict";
 });
-exports.commentRule = exports.createTocRule = exports.badgeRule = void 0;
+exports.commentRule = exports.codeRe = exports.commentRe = exports.createTocRule = exports.badgeRule = void 0;
 
@@ -30,4 +30,8 @@ var _util = require("util");
 exports.createTocRule = createTocRule;
+const commentRe = /<!--[\s\S]*?-->\n*/g;
+exports.commentRe = commentRe;
+const codeRe = /```(\w+\n)?[\s\S]*?\n```/g;
+exports.codeRe = codeRe;
 const commentRule = {
-  re: /<!--[\s\S]*?-->\n*/g,
+  re: commentRe,
 
@@ -34,0 +38,0 @@ replacement() {

build/lib/Toc.js

@@ -16,2 +16,4 @@ "use strict";
 
+var _rules = require("./rules");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -37,5 +39,18 @@
     let res;
+    const matches = [];
+    const b = `${buffer}`.replace(new RegExp(_rules.commentRe, 'g'), '').replace(new RegExp(_methodTitle.methodTitleRe, 'g'), match => {
+      matches.push(match);
+      return match;
+    }).replace(new RegExp(_rules.codeRe, 'g'), match => {
+      const isMatch = _methodTitle.methodTitleRe.test(match);
+
+      if (isMatch) {
+        return matches.shift();
+      }
+
+      return '';
+    });
     const rre = new RegExp(`(?:${re.source})|(?:${_methodTitle.methodTitleRe.source})`, 'g');
 
-    while ((res = rre.exec(buffer)) !== null) {
+    while ((res = rre.exec(b)) !== null) {
       let t;
@@ -42,0 +57,0 @@ let level;

CHANGELOG.md

@@ -0,1 +1,8 @@
+## 21 June 2018
+
+### 1.4.1
+
+- [fix] skip titles from code blocks and comments for Table Of Contents generation.
+- [dep] switch from `dir-stream` to `Pedantry`.
+
 ## 20 June 2018
@@ -2,0 +9,0 @@

package.json

 {
   "name": "documentary",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "A library to manage documentation, such as README, usage, man pages and changelog.",
@@ -58,2 +58,3 @@ "main": "build",
     "catchment": "2.0.1",
+    "pedantry": "1.0.0",
     "restream": "2.1.0",
@@ -60,0 +61,0 @@ "spawncommand": "2.0.1",

README.md

@@ -27,4 +27,2 @@ # documentary
   * [Examples Placement](#examples-placement)
-- [API Method](#api-method)
-- [API Method](#api-method)
 - [CLI](#cli)
@@ -74,3 +72,3 @@ - [API](#api)
 
-Table of contents are useful for navigation the README document. When a `%TOC%` placeholder is found in the file, it will be replaced with an extracted structure.
+Table of contents are useful for navigation the README document. When a `%TOC%` placeholder is found in the file, it will be replaced with an extracted structure. Titles appearing in comments and code blocks will be skipped.
 
@@ -77,0 +75,0 @@ ```md

No alert changes

Improved metrics

Number of low supply chain risk alerts

3

decreased by-25%

Worsened metrics

Total package byte prevSize

46791

decreased by-6.69%

Dependency count

6

increased by20%

Number of package files

24

decreased by-7.69%

Lines of code

412

decreased by-10.24%

Number of lines in readme file

300

decreased by-0.66%

Dependency changes

• + Addedpedantry@1.0.0

• + Added@wrote/read-dir-structure@1.0.0(transitive)

• + Addederotic@1.0.1(transitive)

• + Addedmakepromise@2.0.0(transitive)

• + Addedpedantry@1.0.0(transitive)