fix(docs): snippets are now replaced in jsdoc comments (#411)

Author: Benjamin E. Coe

.jsdoc.js

@@ -26,7 +26,8 @@ module.exports = {
     destination: './docs/'
   },
   plugins: [
-    'plugins/markdown'
+    'plugins/markdown',
+    'jsdoc-region-tag'
   ],
   source: {
     excludePattern: '(^|\\/|\\\\)[._]',

src/interfaces/restify.ts

@@ -128,9 +128,10 @@ function restifyRequestHandler(
   ) {
     listener = () => {
       restifyRequestFinishHandler(client, config, req, res);
-      res.removeListener('finish', (listener as {}) as (
-        ...args: Array<{}>
-      ) => void);
+      res.removeListener(
+        'finish',
+        (listener as {}) as (...args: Array<{}>) => void
+      );
     };
 
     res.on('finish', (listener as {}) as (...args: Array<{}>) => void);

system-test/error-reporting.ts

@@ -463,10 +463,10 @@ describe('error-reporting', () => {
     assert.strictEqual(process.listenerCount('unhandledRejection'), 0);
     oldLogger = console.error;
     console.error = function(this) {
-      const text = util.format.apply(null, (arguments as {}) as [
-        {},
-        Array<{}>
-      ]);
+      const text = util.format.apply(
+        null,
+        (arguments as {}) as [{}, Array<{}>]
+      );
       oldLogger(text);
       logOutput += text;
     };

test/unit/logger.ts

@@ -29,9 +29,10 @@ describe('logger', () => {
     });
     describe('Exception handling', () => {
       it('Should not throw given undefined', () => {
-        assert.doesNotThrow(createLogger, (createLogger() as {}) as (
-          err: Error
-        ) => boolean);
+        assert.doesNotThrow(
+          createLogger,
+          (createLogger() as {}) as (err: Error) => boolean
+        );
       });
       it('Should not throw given an empty object', () => {
         assert.doesNotThrow(
@@ -53,9 +54,12 @@ describe('logger', () => {
       });
       it('Should not throw given an env variable to use', () => {
         process.env.GCLOUD_ERRORS_LOGLEVEL = '4';
-        assert.doesNotThrow(createLogger, (createLogger({
-          logLevel: 4,
-        }) as {}) as (err: Error) => boolean);
+        assert.doesNotThrow(
+          createLogger,
+          (createLogger({
+            logLevel: 4,
+          }) as {}) as (err: Error) => boolean
+        );
         delete process.env.GCLOUD_ERRORS_LOGLEVEL;
       });
       it('Should thow given logLevel as null', () => {

utils/fuzzer.ts

@@ -53,7 +53,11 @@ export class Fuzzer {
       const lenChecked = (is.number(len) ? len : 10)!;
       const chars: string[] = [];
       let thisRange: number[] = [];
-      const ranges = [[48, 57], [65, 90], [97, 122]];
+      const ranges = [
+        [48, 57],
+        [65, 90],
+        [97, 122],
+      ];
 
       for (let i = 0; i < lenChecked; i++) {
         thisRange = ranges[random(0, 2)];