Add generate-toc from joi

Author: AdrieanKhisbe

API.md

@@ -3,50 +3,53 @@
 <!-- versionstop -->
 
 <!-- toc -->
+
 - [Code](#code)
-    - Grammar
-    - Flags
-    - [`expect(value, [prefix])`](#expectvalue-prefix)
-        - Types
-            - [`arguments()`](#arguments)
-            - [`array()`](#array)
-            - [`boolean()`](#boolean)
-            - [`buffer()`](#buffer)
-            - [`date()`](#date)
-            - [`function()`](#function)
-            - [`number()`](#number)
-            - [`regexp()`](#regexp)
-            - [`string()`](#string)
-            - [`object()`](#object)
-        - Values
-            - [`true()`](#true)
-            - [`false()`](#false)
-            - [`null()`](#null)
-            - [`undefined()`](#undefined)
-        - [`include(values)`](#includevalues)
-        - [`startWith(value)`](#startwithvalue)
-        - [`endWith(value)`](#endwithvalue)
-        - [`exist()`](#exist)
-        - [`empty()`](#empty)
-        - [`length(size)`](#lengthsize)
-        - [`equal(value[, options])`](#equalvalue-options)
-        - [`above(value)`](#abovevalue)
-        - [`least(value)`](#leastvalue)
-        - [`below(value)`](#belowvalue)
-        - [`most(value)`](#mostvalue)
-        - [`within(from, to)`](#withinfrom-to)
-        - [`between(from, to)`](#betweenfrom-to)
-        - [`about(value, delta)`](#aboutvalue-delta)
-        - [`instanceof(type)`](#instanceoftype)
-        - [`match(regex)`](#matchregex)
-        - [`satisfy(validator)`](#satisfyvalidator)
-        - [`throw([type], [message])`](#throwtype-message)
-    - [`fail(message)`](#failmessage)
-    - [`count()`](#count)
-    - [`incomplete()`](#incomplete)
-    - [Settings](#settings)
-        - [`truncateMessages`](#truncatemessages)
-        - [`comparePrototypes`](#compareprototypes)
+  - [Grammar](#grammar)
+  - [Flags](#flags)
+  - [`expect(value, [prefix])`](#expectvalue-prefix)
+    - [Types](#types)
+      - [`arguments()`](#arguments)
+      - [`array()`](#array)
+      - [`boolean()`](#boolean)
+      - [`buffer()`](#buffer)
+      - [`date()`](#date)
+      - [`function()`](#function)
+      - [`number()`](#number)
+      - [`regexp()`](#regexp)
+      - [`string()`](#string)
+      - [`object()`](#object)
+    - [Values](#values)
+      - [`true()`](#true)
+      - [`false()`](#false)
+      - [`null()`](#null)
+      - [`undefined()`](#undefined)
+    - [`include(values)`](#includevalues)
+    - [`startWith(value)`](#startwithvalue)
+    - [`endWith(value)`](#endwithvalue)
+    - [`exist()`](#exist)
+    - [`empty()`](#empty)
+    - [`length(size)`](#lengthsize)
+    - [`equal(value[, options])`](#equalvalue-options)
+    - [`above(value)`](#abovevalue)
+    - [`least(value)`](#leastvalue)
+    - [`below(value)`](#belowvalue)
+    - [`most(value)`](#mostvalue)
+    - [`within(from, to)`](#withinfrom-to)
+    - [`between(from, to)`](#betweenfrom-to)
+    - [`about(value, delta)`](#aboutvalue-delta)
+    - [`instanceof(type)`](#instanceoftype)
+    - [`match(regex)`](#matchregex)
+    - [`satisfy(validator)`](#satisfyvalidator)
+    - [`throw([type], [message])`](#throwtype-message)
+  - [`fail(message)`](#failmessage)
+  - [`count()`](#count)
+  - [`incomplete()`](#incomplete)
+  - [Settings](#settings)
+    - [`truncateMessages`](#truncatemessages)
+    - [`comparePrototypes`](#compareprototypes)
+
+<!-- tocstop -->
 
 ## Code
 

generate-api-toc.js

@@ -0,0 +1,36 @@
+'use strict';
+// From https://github.com/hapijs/joi/blob/master/generate-readme-toc.js
+
+// Load modules
+
+const Toc = require('markdown-toc');
+const Fs = require('fs');
+const Package = require('./package.json');
+
+// Declare internals
+
+const internals = {
+    filename: './API.md'
+};
+
+
+internals.generate = function () {
+
+    const api = Fs.readFileSync(internals.filename, 'utf8');
+    const tocOptions = {
+        bullets: '-',
+        slugify: function (text) {
+
+            return text.toLowerCase()
+                .replace(/\s/g, '-')
+                .replace(/[^\w-]/g, '');
+        }
+    };
+
+    const output = Toc.insert(api, tocOptions)
+        .replace(/<!-- version -->(.|\n)*<!-- versionstop -->/, '<!-- version -->\n# ' + Package.version + ' API Reference\n<!-- versionstop -->');
+
+    Fs.writeFileSync(internals.filename, output);
+};
+
+internals.generate();

package.json

@@ -16,11 +16,14 @@
         "hoek": "3.x.x"
     },
     "devDependencies": {
-        "lab": "7.x.x"
+        "lab": "8.x.x",
+        "markdown-toc": "^0.12.3"
     },
     "scripts": {
         "test": "lab -v -t 100 -L",
-        "test-cov-html": "lab -L -r html -o coverage.html"
+        "test-cov-html": "lab -L -r html -o coverage.html",
+        "toc": "node generate-api-toc.js",
+        "version": "npm run toc && git add API.md"
     },
     "license": "BSD-3-Clause"
 }