doc,tools,test: lint doc-based addon tests
authorRich Trott <rtrott@gmail.com>
Thu, 25 Feb 2016 01:07:45 +0000 (17:07 -0800)
committerMyles Borins <mborins@us.ibm.com>
Wed, 2 Mar 2016 22:01:11 +0000 (14:01 -0800)
PR-URL: https://github.com/nodejs/node/pull/5427
Fixes: https://github.com/nodejs/node/issues/5424
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
doc/api/addons.markdown
tools/doc/addon-verify.js

index c9aea39..7f570eb 100644 (file)
@@ -317,7 +317,7 @@ Once compiled, the example Addon can be required and used from within Node.js:
 // test.js
 const addon = require('./build/Release/addon');
 
-console.log('This should be eight:', addon.add(3,5));
+console.log('This should be eight:', addon.add(3, 5));
 ```
 
 
@@ -422,7 +422,7 @@ const addon = require('./build/Release/addon');
 
 var obj1 = addon('hello');
 var obj2 = addon('world');
-console.log(obj1.msg+' '+obj2.msg); // 'hello world'
+console.log(obj1.msg + ' ' + obj2.msg); // 'hello world'
 ```
 
 
@@ -637,9 +637,9 @@ Test it with:
 const addon = require('./build/Release/addon');
 
 var obj = new addon.MyObject(10);
-console.log( obj.plusOne() ); // 11
-console.log( obj.plusOne() ); // 12
-console.log( obj.plusOne() ); // 13
+console.log(obj.plusOne()); // 11
+console.log(obj.plusOne()); // 12
+console.log(obj.plusOne()); // 13
 ```
 
 ### Factory of wrapped objects
@@ -823,14 +823,14 @@ Test it with:
 const createObject = require('./build/Release/addon');
 
 var obj = createObject(10);
-console.log( obj.plusOne() ); // 11
-console.log( obj.plusOne() ); // 12
-console.log( obj.plusOne() ); // 13
+console.log(obj.plusOne()); // 11
+console.log(obj.plusOne()); // 12
+console.log(obj.plusOne()); // 13
 
 var obj2 = createObject(20);
-console.log( obj2.plusOne() ); // 21
-console.log( obj2.plusOne() ); // 22
-console.log( obj2.plusOne() ); // 23
+console.log(obj2.plusOne()); // 21
+console.log(obj2.plusOne()); // 22
+console.log(obj2.plusOne()); // 23
 ```
 
 
index 792fd69..6aafb8f 100644 (file)
@@ -71,6 +71,12 @@ function verifyFiles(files, blockName, onprogress, ondone) {
   );
 
   files = Object.keys(files).map(function(name) {
+    if (name === 'test.js') {
+      files[name] = `'use strict';
+require('../../common');
+${files[name]}
+`;
+    }
     return {
       path: path.resolve(dir, name),
       name: name,