docs: lint code snippets (#1772)

callmehiphop · stephenplusplus · commit 116436fa789d · 2016-11-07T17:40:13.000-05:00
diff --git a/packages/bigtable/src/instance.js b/packages/bigtable/src/instance.js
@@ -87,7 +87,7 @@ function Instance(bigtable, name) {
      * instance.create().then(function(data) {
      *   var instance = data[0];
      *   var operation = data[1];
-     *   var apiResponse = data[2]
+     *   var apiResponse = data[2];
      * });
      */
     create: true,
diff --git a/packages/bigtable/src/row.js b/packages/bigtable/src/row.js
@@ -744,7 +744,7 @@ Row.prototype.getMetadata = function(options, callback) {
  *   }
  * };
  *
- * row.increment('follows:gwashington', callback)
+ * row.increment('follows:gwashington', callback);
  *
  * //-
  * // Specify a custom amount to increment the column by.
diff --git a/packages/bigtable/src/table.js b/packages/bigtable/src/table.js
@@ -792,7 +792,7 @@ Table.prototype.insert = function(entries, callback) {
  *   }
  * ];
  *
- * table.mutate(entries, callback)
+ * table.mutate(entries, callback);
  *
  * //-
  * // Delete entities. See {module:bigtable/row#deleteCells}
diff --git a/packages/compute/src/instance-group.js b/packages/compute/src/instance-group.js
@@ -70,7 +70,7 @@ function InstanceGroup(zone, name) {
      * instanceGroup.create().then(function(data) {
      *   var instanceGroup = data[0];
      *   var operation = data[1];
-     *   var apiResponse = data[2]
+     *   var apiResponse = data[2];
      * });
      */
     create: true,
diff --git a/packages/datastore/src/request.js b/packages/datastore/src/request.js
@@ -750,7 +750,7 @@ DatastoreRequest.prototype.runQueryStream = function(query, options) {
  *     name: 'DonutShack',
  *     rating: 8
  *   }
- * }
+ * };
  *
  * datastore.save(entity, function(err) {
  *   console.log(key.path); // ['Company', 'donutshack']
diff --git a/scripts/docs/builder.js b/scripts/docs/builder.js
@@ -56,7 +56,7 @@ function Builder(name, version, cwd) {
   this.version = version || config.DEFAULT_VERSION;
   this.dir = path.join(cwd || '', DOCS_ROOT, name, this.version);
   this.isUmbrella = name === UMBRELLA_PACKAGE;
-  this.isMaster = this.version === config.DEFAULT_VERSION;
+  this.isRelease = !!semver.valid(this.version);
 }
 
 /**
@@ -112,7 +112,7 @@ Builder.prototype.build = function() {
  * var tagName = builder.getTagName(); // bigtable-0.2.0
  */
 Builder.prototype.getTagName = function() {
-  if (this.isMaster) {
+  if (!semver.valid(this.version)) {
     return this.version;
   }
 
@@ -233,7 +233,7 @@ function Bundler(builder) {
  * Bundler.updateDep(builder);
  */
 Bundler.updateDep = function(builder) {
-  if (builder.isMaster) {
+  if (!builder.isRelease) {
     throw new Error('Must supply valid version to update bundles with.');
   }
 
@@ -252,7 +252,7 @@ Bundler.updateDep = function(builder) {
     bundleTag = bundler.builder.getTagName();
     git.checkout(bundleTag);
 
-    dep = findWhere(bundler.getDeps(), { name: builder.name });
+    dep = findWhere(bundler.getDeps(), { name: builder.name }) || {};
     git.checkout('-');
 
     if (semver.maxSatisfying(versions, dep.version) !== builder.version) {
@@ -440,10 +440,13 @@ function build(name, version) {
   git.checkout(builder.getTagName());
   builder.build();
   git.checkout('-');
-  builder.updateManifest();
 
-  if (!builder.isUmbrella && !builder.isMaster) {
-    Bundler.updateDep(builder);
+  if (builder.isRelease) {
+    builder.updateManifest();
+
+    if (!builder.isUmbrella) {
+      Bundler.updateDep(builder);
+    }
   }
 }
 
@@ -456,13 +459,14 @@ module.exports.build = build;
  * builder.buildAll();
  */
 function buildAll() {
+  var currentBranch = git.branch.current;
   var modules = globby.sync('*', {
     cwd: PACKAGES_ROOT,
     ignore: config.IGNORE
   });
 
   modules.forEach(function(name) {
-    build(name, config.DEFAULT_VERSION);
+    build(name, currentBranch);
   });
 }
 
diff --git a/test/docs.js b/test/docs.js
@@ -20,6 +20,7 @@ var createErrorClass = require('create-error-class');
 var format = require('string-format-obj');
 var fs = require('fs');
 var glob = require('glob');
+var jshint = require('jshint').JSHINT;
 var mitm = require('mitm');
 var multiline = require('multiline');
 var overviews = require('../scripts/docs/config').OVERVIEW;
@@ -41,7 +42,19 @@ var DocsError = createErrorClass('DocsError', function(err, code) {
     })
     .join('\n');
 
-  this.message = '\n' + lines + '\n\n' + err.message;
+  this.message = format('\n{lines}\n\n{message}', {
+    lines: lines,
+    message: err.message
+  });
+});
+
+var JSHintError = createErrorClass('JSHintError', function(err) {
+  this.message = format('"{evidence}" - {reason}', {
+    evidence: err.evidence.trim(),
+    reason: err.reason
+  });
+
+  this.code = err.code;
 });
 
 var FakeConsole = Object.keys(console)
@@ -144,6 +157,21 @@ modules.forEach(function(mod) {
           var snippet = createSnippet(mod, moduleInstantationCode, method);
 
           it('should run ' + name + ' examples without errors', function() {
+            jshint(snippet, {
+              // in several snippets we give an example as to how to access
+              // a property (like metadata) without doing anything with it
+              // e.g. `list[0].metadata`
+              expr: true,
+
+              // this allows us to redefine variables, generally it's bad, buuut
+              // for copy/paste purposes this is desirable within the docs
+              shadow: true
+            });
+
+            if (jshint.errors.length) {
+              throw new JSHintError(jshint.errors[0]);
+            }
+
             runCodeInSandbox(snippet, sandbox);
           });
         });
@@ -153,7 +181,7 @@ modules.forEach(function(mod) {
 
 function getDocs(mod) {
   return glob
-    .sync('docs/json/' + mod + '/master/*.json', {
+    .sync('docs/json/' + mod + '/*/*.json', {
       ignore: [
         '**/toc.json',
         '**/types.json'

Original file line number	Diff line number	Diff line change
`@@ -744,7 +744,7 @@ Row.prototype.getMetadata = function(options, callback) {`
`744`	`744`	`* }`
`745`	`745`	`* };`
`746`	`746`	`*`
`747`		`- * row.increment('follows:gwashington', callback)`
	`747`	`+ * row.increment('follows:gwashington', callback);`
`748`	`748`	`*`
`749`	`749`	`* //-`
`750`	`750`	`* // Specify a custom amount to increment the column by.`
Original file line number	Diff line number	Diff line change
`@@ -792,7 +792,7 @@ Table.prototype.insert = function(entries, callback) {`
`792`	`792`	`* }`
`793`	`793`	`* ];`
`794`	`794`	`*`
`795`		`- * table.mutate(entries, callback)`
	`795`	`+ * table.mutate(entries, callback);`
`796`	`796`	`*`
`797`	`797`	`* //-`
`798`	`798`	`* // Delete entities. See {module:bigtable/row#deleteCells}`
Original file line number	Diff line number	Diff line change
`@@ -750,7 +750,7 @@ DatastoreRequest.prototype.runQueryStream = function(query, options) {`
`750`	`750`	`* name: 'DonutShack',`
`751`	`751`	`* rating: 8`
`752`	`752`	`* }`
`753`		`- * }`
	`753`	`+ * };`
`754`	`754`	`*`
`755`	`755`	`* datastore.save(entity, function(err) {`
`756`	`756`	`* console.log(key.path); // ['Company', 'donutshack']`