Merge pull request #282 from randycoulman/add-links-between-docs

searls · web-flow · commit 83ebd6a172e6 · 2017-08-18T11:41:00.000-04:00
Add previous/next links to documentation files
diff --git a/README.md b/README.md
@@ -70,66 +70,66 @@ numbered for easy reading in the priority-order we anticipate people needing the
 Here's a rough outline:
 
 1. [Installation](docs/1-installation.md#installing-testdoublejs)
-  1. [for Node.js](docs/1-installation.md#for-use-in-nodejs-or-browserify)
-  2. [for browsers](docs/1-installation.md#for-use-in-browsers)
-  3. [initial configuration](docs/1-installation.md#configuring-testdoublejs-setting-up-in-your-test-suite)
-2. [Purpose of testdouble.js](docs/2-howto-purpose.md#background)
-  1. [in unit tests](docs/2-howto-purpose.md#test-doubles-and-unit-tests)
-  2. [in integration tests](docs/2-howto-purpose.md#test-doubles-and-integration-tests)
+   1. [for Node.js](docs/1-installation.md#for-use-in-nodejs-or-browserify)
+   2. [for browsers](docs/1-installation.md#for-use-in-browsers)
+   3. [initial configuration](docs/1-installation.md#configuring-testdoublejs-setting-up-in-your-test-suite)
+2. [Purpose of testdouble.js](docs/2-howto-purpose.md#purpose)
+   1. [in unit tests](docs/2-howto-purpose.md#test-doubles-and-unit-tests)
+   2. [in integration tests](docs/2-howto-purpose.md#test-doubles-and-integration-tests)
 3. [Getting started tutorial](docs/3-getting-started.md#getting-started)
 4. [Creating test doubles](docs/4-creating-test-doubles.md#creating-test-doubles)
-  1. [test double functions with `td.function()`](docs/4-creating-test-doubles.md#tdfunctionname)
-  2. [test double objects with `td.object()`](docs/4-creating-test-doubles.md#tdobject)
-  3. [test double constructors with `td.constructor()`](docs/4-creating-test-doubles.md#tdconstructor)
+   1. [test double functions with `td.function()`](docs/4-creating-test-doubles.md#tdfunctionname)
+   2. [test double objects with `td.object()`](docs/4-creating-test-doubles.md#tdobject)
+   3. [test double constructors with `td.constructor()`](docs/4-creating-test-doubles.md#tdconstructor)
 5. [Stubbing responses](docs/5-stubbing-results.md#stubbing-behavior)
-  1. [td.when() API](docs/5-stubbing-results.md#tdwhen)
-  2. [equality argument matching](docs/5-stubbing-results.md#simple-precise-argument-stubbing)
-  3. [one-liner stubbings](docs/5-stubbing-results.md#one-liner-stubbings)
-  4. [stubbing sequential return values](docs/5-stubbing-results.md#stubbing-sequential-return-values)
-  5. [argument matchers](docs/5-stubbing-results.md#loosening-stubbings-with-argument-matchers)
-    1. [td.matchers.anything()](docs/5-stubbing-results.md#tdmatchersanything)
-    2. [td.matchers.isA()](docs/5-stubbing-results.md#tdmatchersisa)
-    3. [td.matchers.contains()](docs/5-stubbing-results.md#tdmatcherscontains)
-      1. [matching strings](docs/5-stubbing-results.md#strings)
-      2. [matching arrays](docs/5-stubbing-results.md#arrays)
-      3. [matching objects](docs/5-stubbing-results.md#objects)
-    4. [td.matchers.argThat()](docs/5-stubbing-results.md#tdmatchersargthat)
-    5. [td.matchers.not()](docs/5-stubbing-results.md#tdmatchersnot)
-  6. [Stubbing callback APIs](docs/5-stubbing-results.md#stubbing-callback-apis)
-  7. [Stub exceptions with thenThrow](docs/5-stubbing-results.md#stub-exceptions-with-thenthrow)
-  8. [Stub promises with thenResolve and thenReject](docs/5-stubbing-results.md#stub-promises-with-thenresolve-and-thenreject)
-  9. [Stub side effects with thenDo](docs/5-stubbing-results.md#stub-side-effects-with-thendo)
-  10. [Configuring stubbings](docs/5-stubbing-results.md#configuring-stubbings)
-    1. [ignoreExtraArgs](docs/5-stubbing-results.md#ignoreextraargs)
-    2. [times](docs/5-stubbing-results.md#times)
-    3. [defer](docs/5-stubbing-results.md#defer)
-    4. [delay](docs/5-stubbing-results.md#delay)
+   1. [td.when() API](docs/5-stubbing-results.md#tdwhen)
+   2. [equality argument matching](docs/5-stubbing-results.md#simple-precise-argument-stubbing)
+   3. [one-liner stubbings](docs/5-stubbing-results.md#one-liner-stubbings)
+   4. [stubbing sequential return values](docs/5-stubbing-results.md#stubbing-sequential-return-values)
+   5. [argument matchers](docs/5-stubbing-results.md#loosening-stubbings-with-argument-matchers)
+      1. [td.matchers.anything()](docs/5-stubbing-results.md#tdmatchersanything)
+      2. [td.matchers.isA()](docs/5-stubbing-results.md#tdmatchersisa)
+      3. [td.matchers.contains()](docs/5-stubbing-results.md#tdmatcherscontains)
+         1. [matching strings](docs/5-stubbing-results.md#strings)
+         2. [matching arrays](docs/5-stubbing-results.md#arrays)
+         3. [matching objects](docs/5-stubbing-results.md#objects)
+      4. [td.matchers.argThat()](docs/5-stubbing-results.md#tdmatchersargthat)
+      5. [td.matchers.not()](docs/5-stubbing-results.md#tdmatchersnot)
+   6. [Stubbing callback APIs](docs/5-stubbing-results.md#stubbing-callback-apis)
+   7. [Stub exceptions with thenThrow](docs/5-stubbing-results.md#stub-exceptions-with-thenthrow)
+   8. [Stub promises with thenResolve and thenReject](docs/5-stubbing-results.md#stub-promises-with-thenresolve-and-thenreject)
+   9. [Stub side effects with thenDo](docs/5-stubbing-results.md#stub-side-effects-with-thendo)
+   10. [Configuring stubbings](docs/5-stubbing-results.md#configuring-stubbings)
+      1. [ignoreExtraArgs](docs/5-stubbing-results.md#ignoreextraargs)
+      2. [times](docs/5-stubbing-results.md#times)
+      3. [defer](docs/5-stubbing-results.md#defer)
+      4. [delay](docs/5-stubbing-results.md#delay)
 6. [Verifying invocations](docs/6-verifying-invocations.md#verifying-interactions)
-  1. [td.verify() API](docs/6-verifying-invocations.md#tdverify)
-  2. [equality argument matching](docs/6-verifying-invocations.md#arguments)
-  3. [argument matchers](docs/6-verifying-invocations.md#relaxing-verifications-with-argument-matchers)
-    1. [td.matchers.anything()](docs/6-verifying-invocations.md#tdmatchersanything)
-    2. [td.matchers.isA()](docs/6-verifying-invocations.md#tdmatchersisa)
-    3. [td.matchers.contains()](docs/6-verifying-invocations.md#tdmatcherscontains)
-      1. [matching strings](docs/6-verifying-invocations.md#strings)
-      2. [matching arrays](docs/6-verifying-invocations.md#arrays)
-      3. [matching objects](docs/6-verifying-invocations.md#objects)
-    4. [td.matchers.argThat()](docs/6-verifying-invocations.md#tdmatchersargthat)
-  4. [Argument captors](docs/6-verifying-invocations.md#multi-phase-assertions-with-argument-captors)
-  5. [Configuring verifications](docs/6-verifying-invocations.md#configuring-verifications)
-    1. [ignoreExtraArgs](docs/6-verifying-invocations.md#ignoreextraargs)
-    2. [times](docs/6-verifying-invocations.md#times)
+   1. [td.verify() API](docs/6-verifying-invocations.md#tdverify)
+   2. [equality argument matching](docs/6-verifying-invocations.md#arguments)
+   3. [argument matchers](docs/6-verifying-invocations.md#relaxing-verifications-with-argument-matchers)
+      1. [td.matchers.anything()](docs/6-verifying-invocations.md#tdmatchersanything)
+      2. [td.matchers.isA()](docs/6-verifying-invocations.md#tdmatchersisa)
+      3. [td.matchers.contains()](docs/6-verifying-invocations.md#tdmatcherscontains)
+         1. [matching strings](docs/6-verifying-invocations.md#strings)
+         2. [matching arrays](docs/6-verifying-invocations.md#arrays)
+         3. [matching objects](docs/6-verifying-invocations.md#objects)
+      4. [td.matchers.argThat()](docs/6-verifying-invocations.md#tdmatchersargthat)
+   4. [Argument captors](docs/6-verifying-invocations.md#multi-phase-assertions-with-argument-captors)
+   5. [Configuring verifications](docs/6-verifying-invocations.md#configuring-verifications)
+      1. [ignoreExtraArgs](docs/6-verifying-invocations.md#ignoreextraargs)
+      2. [times](docs/6-verifying-invocations.md#times)
 7. [Replacing dependencies with test doubles](docs/7-replacing-dependencies.md#replacing-real-dependencies-with-test-doubles)
-  1. [for Node.js](docs/7-replacing-dependencies.md#nodejs)
-  2. [for Browser JS](docs/7-replacing-dependencies.md#browser)
-  3. [td.replace() API](docs/7-replacing-dependencies.md#testdoublereplace-api)
+   1. [for Node.js](docs/7-replacing-dependencies.md#nodejs)
+   2. [for Browser JS](docs/7-replacing-dependencies.md#browser)
+   3. [td.replace() API](docs/7-replacing-dependencies.md#testdoublereplace-api)
 8. [Writing custom argument matchers](docs/8-custom-matchers.md#custom-argument-matchers)
 9. [Debugging with testdouble.js](docs/9-debugging.md#debugging-with-testdoublejs)
-  1. [td.explain() API](docs/9-debugging.md#tdexplainsometestdouble)
+   1. [td.explain() API](docs/9-debugging.md#tdexplainsometestdouble)
 10. [Plugins](docs/A-plugins.md#plugins)
-  1. [testdouble-chai](https://github.com/basecase/testdouble-chai)
-  2. [testdouble-jasmine](https://github.com/BrianGenisio/testdouble-jasmine)
+    1. [testdouble-chai](https://github.com/basecase/testdouble-chai)
+    2. [testdouble-jasmine](https://github.com/BrianGenisio/testdouble-jasmine)
 11. [Frequently Asked Questions](docs/B-frequently-asked-questions.md#frequently-asked-questions)
-  1. [Why doesn't `td.replace()` work with external CommonJS modules?](docs/B-frequently-asked-questions.md#why-doesnt-tdreplace-work-with-external-commonjs-modules)
-12. [Configuration](docs/C-configuration.md)
-  1. [td.config](docs/C-configuration.md#tdconfig)
+    1. [Why doesn't `td.replace()` work with external CommonJS modules?](docs/B-frequently-asked-questions.md#why-doesnt-tdreplace-work-with-external-commonjs-modules)
+12. [Configuration](docs/C-configuration.md#configuration)
+    1. [td.config](docs/C-configuration.md#tdconfig)
diff --git a/docs/1-installation.md b/docs/1-installation.md
@@ -100,3 +100,6 @@ QUnit.testDone(function() {
   td.reset()
 })
 ```
+
+***
+Next:  [Purpose](2-howto-purpose.md#purpose)
diff --git a/docs/2-howto-purpose.md b/docs/2-howto-purpose.md
@@ -109,3 +109,7 @@ in adapter functions to fake those adapters instead of the 3rd-party API—this
 will decrease the degree to which test doubles will leak throughout the
 integrated test suite and afford some opportunity for responding to hard-to-test
 situations by improving the API design of your adapters.
+
+***
+Previous: [Installing testdouble.js](1-installation.md#installing-testdoublejs)
+Next:  [Getting Started](3-getting-started.md#getting-started)
diff --git a/docs/3-getting-started.md b/docs/3-getting-started.md
@@ -354,3 +354,7 @@ Further reading that documents the features shown off in this tutorial include:
 * [Creating test doubles with `function()` and `object()`](4-creating-test-doubles.md)
 * [Stubbing responses with `when()`](5-stubbing-results.md)
 * [Verifying invocations with `verify()`](6-verifying-invocations.md)
+
+***
+Previous: [Purpose](2-howto-purpose.md#purpose)
+Next: [Creating Test Doubles](4-creating-test-doubles.md#creating-test-doubles)
diff --git a/docs/4-creating-test-doubles.md b/docs/4-creating-test-doubles.md
@@ -223,3 +223,7 @@ FakeCat.prototype.scratch // a test double function named '#scratch'
 ## Conclusion
 
 As you can see, there are a plethora of ways to create test doubles with testdouble.js, each designed to handle a different style of organizing JavaScript code. We recommend on landing on one consistent style (e.g. each module as one function) for each project, which in turn would encourage one consistent style of creating test doubles. This API is written to be flexible for a number of potential contexts across objects, but it has come at the cost of a large enough surface area that if any project were to make ample use of all or most of the above invocation styles, it would confuse readers.
+
+***
+Previous: [Getting Started](3-getting-started.md#getting-started)
+Next: [Stubbing behavior](5-stubbing-results.md#stubbing-behavior)
diff --git a/docs/5-stubbing-results.md b/docs/5-stubbing-results.md
@@ -622,3 +622,7 @@ other major feature of any test double library—verifying an invocation took
 place—has an API that was carefully-designed to be completely symmetrical! Read
 on about [verifying interactions with `verify()`](6-verifying-invocations.md),
 and rest easy knowing that you already know exactly how to do it.
+
+***
+Previous: [Creating Test Doubles](4-creating-test-doubles.md#creating-test-doubles#creating-test-doubles)
+Next: [Verifying interactions](6-verifying-invocations.md#verifying-interactions)
diff --git a/docs/6-verifying-invocations.md b/docs/6-verifying-invocations.md
@@ -373,3 +373,7 @@ td.verify(doNotCall(), {times: 0, ignoreExtraArgs: true}) // passes
 And that's everything there is to know about verifying behavior with
 testdouble.js! At this point, you know everything you need to know to be pretty
 dangerous writing isolated tests.
+
+***
+Previous: [Stubbing behavior](5-stubbing-results.md#stubbing-behavior)
+Next: [Replacing Real Dependencies with Test Doubles](7-replacing-dependencies.md#replacing-real-dependencies-with-test-doubles)
diff --git a/docs/7-replacing-dependencies.md b/docs/7-replacing-dependencies.md
@@ -228,4 +228,6 @@ path shouldn't exist yet, a second argument `manualReplacement` can be provided
 to short-circuit any attempts to load and imitate a module at
 `relativePathToModule`.
 
-
+***
+Previous: [Verifying interactions](6-verifying-invocations.md#verifying-interactions)
+Next: [Custom argument matchers](8-custom-matchers.md#custom-argument-matchers)
diff --git a/docs/8-custom-matchers.md b/docs/8-custom-matchers.md
@@ -1,4 +1,4 @@
-### Custom argument matchers
+# Custom argument matchers
 
 In addition to the built-in argument matchers described along with
 [stubbing](5-stubbing-results.md#loosening-stubbings-with-argument-matchers),
@@ -17,7 +17,7 @@ actual invocation if it passes lodash's deep
 
 The examples in this document assume you've aliased `testdouble` to `td`.
 
-#### Example
+## Example
 
 Here's a naive implementation of a matcher named `isA` which will check whether
 the expected type of an argument matches the type of the argument actually passed
@@ -44,7 +44,7 @@ datePicker(new Date()) // 'good'
 datePicker(5) // undefined
 ```
 
-#### td.matchers.create API
+## td.matchers.create API
 
 The `create` function takes a configuration object with the following properties
 
@@ -64,3 +64,7 @@ opportunity to mutate the matcher instance or have some other side effect. The
 
 For some examples of `td.matchers.create()` in action, check out the
 [built-in matchers](src/matchers/index.coffee) provided by testdouble.js.
+
+***
+Previous: [Replacing Real Dependencies with Test Doubles](7-replacing-dependencies.md#replacing-real-dependencies-with-test-doubles)
+Next: [Debugging with testdouble.js](9-debugging.md#debugging-with-testdoublejs)
diff --git a/docs/9-debugging.md b/docs/9-debugging.md
@@ -79,4 +79,6 @@ If you'd like to make `explain()` even better, consider sending a pull request
 to make [`explain` describe test double objects](https://github.com/testdouble/testdouble.js/issues/48)
 in addition to functions.
 
-
+***
+Previous: [Custom argument matchers](8-custom-matchers.md#custom-argument-matchers)
+Next: [Plugins](A-plugins.md#plugins)
diff --git a/docs/A-plugins.md b/docs/A-plugins.md
@@ -25,14 +25,14 @@ Jasmine `expect` matchers (WIP by @BrianGenisio)
 
 ## Build Plugins
 
-Sometimes, it can be handy to have a ready-made shim to pull in and configure the 
+Sometimes, it can be handy to have a ready-made shim to pull in and configure the
 library for various build tools. Here's what testdouble.js has so far:
 
-* [ember-cli-testdouble](https://github.com/isleofcode/ember-cli-testdouble) by 
-[@AlexBlom](https://github.com/AlexBlom) provides a shim for easy importing of 
+* [ember-cli-testdouble](https://github.com/isleofcode/ember-cli-testdouble) by
+[@AlexBlom](https://github.com/AlexBlom) provides a shim for easy importing of
 testdouble.js by Ember projects that using Ember CLI
-* [karma-testdouble](https://github.com/kahwee/karma-testdouble) by 
-[@kahwee](https://github.com/kahwee) will configure 
+* [karma-testdouble](https://github.com/kahwee/karma-testdouble) by
+[@kahwee](https://github.com/kahwee) will configure
 [Karma](https://karma-runner.github.io) to load test double's browser
 distribution
 
@@ -46,3 +46,7 @@ testing that a component debounces user input).
 This API has been ported for use with testdouble.js by
 [@kuy](https://github.com/kuy) as
 [testdouble-timers](https://github.com/kuy/testdouble-timers).
+
+***
+Previous: [Debugging with testdouble.js](9-debugging.md#debugging-with-testdoublejs)
+Next: [Frequently Asked Questions](B-frequently-asked-questions.md#frequently-asked-questions)
diff --git a/docs/B-frequently-asked-questions.md b/docs/B-frequently-asked-questions.md
@@ -43,3 +43,7 @@ be nothing wrong with the implementation.
 
 As a result, testdouble.js will print a console warning when it detects that
 a stubbed invocation is also being verified.
+
+***
+Previous: [Plugins](A-plugins.md#plugins)
+Next: [Configuration](C-configuration.md#configuration)
diff --git a/docs/C-configuration.md b/docs/C-configuration.md
@@ -17,3 +17,6 @@ Note that this config is persisted, so under normal circumstances, setting any
 configuration property will hold for the duration of the entire test suite. If
 you need to change a configuration property for a single test, you'll need to
 manage undoing the change yourself (e.g. in `beforeEach` and `afterEach` hooks).
+
+***
+Previous: [Frequently Asked Questions](B-frequently-asked-questions.md#frequently-asked-questions)
