docs: provide complete table of contents

Author: dougwilson

Readme.md

@@ -16,28 +16,32 @@
 - [Community](#community)
 - [Establishing connections](#establishing-connections)
 - [Connection options](#connection-options)
-- [SSL options](#ssl-options)
+  - [SSL options](#ssl-options)
 - [Terminating connections](#terminating-connections)
 - [Pooling connections](#pooling-connections)
 - [Pool options](#pool-options)
 - [Pool events](#pool-events)
+  - [acquire](#acquire)
+  - [connection](#connection)
+  - [enqueue](#enqueue)
+  - [release](#release)
 - [Closing all the connections in a pool](#closing-all-the-connections-in-a-pool)
 - [PoolCluster](#poolcluster)
-- [PoolCluster options](#poolcluster-options)
+  - [PoolCluster options](#poolcluster-options)
 - [Switching users and altering connection state](#switching-users-and-altering-connection-state)
 - [Server disconnects](#server-disconnects)
 - [Performing queries](#performing-queries)
 - [Escaping query values](#escaping-query-values)
 - [Escaping query identifiers](#escaping-query-identifiers)
-- [Preparing Queries](#preparing-queries)
-- [Custom format](#custom-format)
+  - [Preparing Queries](#preparing-queries)
+  - [Custom format](#custom-format)
 - [Getting the id of an inserted row](#getting-the-id-of-an-inserted-row)
 - [Getting the number of affected rows](#getting-the-number-of-affected-rows)
 - [Getting the number of changed rows](#getting-the-number-of-changed-rows)
 - [Getting the connection ID](#getting-the-connection-id)
 - [Executing queries in parallel](#executing-queries-in-parallel)
 - [Streaming query rows](#streaming-query-rows)
-- [Piping results with Streams](#piping-results-with-streams)
+  - [Piping results with Streams](#piping-results-with-streams)
 - [Multiple statement queries](#multiple-statement-queries)
 - [Stored procedures](#stored-procedures)
 - [Joins with overlapping column names](#joins-with-overlapping-column-names)
@@ -47,11 +51,21 @@
 - [Error handling](#error-handling)
 - [Exception Safety](#exception-safety)
 - [Type casting](#type-casting)
+  - [Number](#number)
+  - [Date](#date)
+  - [Buffer](#buffer)
+  - [String](#string)
+  - [Custom type casting](#custom-type-casting)
 - [Connection Flags](#connection-flags)
+  - [Example](#example)
+  - [Default Flags](#default-flags)
+  - [Other Available Flags](#other-available-flags)
 - [Debugging and reporting problems](#debugging-and-reporting-problems)
 - [Security issues](#security-issues)
 - [Contributing](#contributing)
 - [Running tests](#running-tests)
+  - [Running unit tests](#running-unit-tests)
+  - [Running integration tests](#running-integration-tests)
 - [Todo](#todo)
 
 ## Install

package.json

@@ -37,7 +37,7 @@
     "node": ">= 0.6"
   },
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint . && node tool/lint-readme.js",
     "test": "node test/run.js",
     "test-ci": "node tool/install-nyc.js --nyc-optional --reporter=text -- npm test",
     "test-cov": "node tool/install-nyc.js --reporter=html --reporter=text -- npm test",

tool/lint-readme.js

@@ -0,0 +1,75 @@
+var fs   = require('fs');
+var path = require('path');
+var util = require('util');
+
+var MARKDOWN_SECTION_REGEXP = /^(#+) (.+)$/;
+var NEWLINE_REGEXP          = /\r?\n/;
+var README_PATH             = path.join(__dirname, '..', 'Readme.md');
+var README_CONTENTS         = fs.readFileSync(README_PATH, 'utf-8');
+var TOC_SECTION_NAME        = 'Table of Contents';
+
+var currentSectionLevel = null;
+var currentSectionName  = null;
+var currentToc          = [];
+var expectedToc         = [];
+var tocOffset           = 0;
+
+README_CONTENTS.split(NEWLINE_REGEXP).forEach(function (line, index) {
+  var match = MARKDOWN_SECTION_REGEXP.exec(line);
+
+  if (match) {
+    currentSectionLevel = match[1].length;
+    currentSectionName  = match[2];
+
+    if (currentSectionName === TOC_SECTION_NAME) {
+      tocOffset = index;
+    }
+
+    if (currentSectionLevel > 1 && currentSectionName !== TOC_SECTION_NAME) {
+      expectedToc.push(util.format('%s- [%s](%s)',
+        repeat('  ', (currentSectionLevel - 2)), currentSectionName, toAnchor(currentSectionName)));
+    }
+  } else if (currentSectionName === TOC_SECTION_NAME) {
+    currentToc.push(line);
+  }
+});
+
+var index = 0;
+
+if (currentToc[index++].length !== 0) {
+  expect((tocOffset + index), 'blank line', currentToc[index - 1]);
+}
+
+expectedToc.forEach(function (expectedLine) {
+  var currentLine = currentToc[index++] || '';
+
+  if (expectedLine !== currentLine) {
+    var currentIndex = currentToc.indexOf(expectedLine);
+
+    expect((tocOffset + index), ('"' + expectedLine + '"'), currentLine);
+
+    if (currentIndex !== -1) {
+      index = currentIndex + 1;
+    }
+  }
+});
+
+function expect (lineidx, message, line) {
+  console.log('Expected %s on line %d', message, (lineidx + 1));
+  console.log('  Got: %s', line);
+  process.exitCode = 1;
+}
+
+function  repeat (str, num) {
+  var s = '';
+
+  for (var i = 0; i < num; i++) {
+    s += str;
+  }
+
+  return s;
+}
+
+function toAnchor (section) {
+  return '#' + section.toLowerCase().replace(/ /g, '-');
+}