Skip to content

Commit e703b18

Browse files
TrottMyles Borins
authored andcommitted
doc,tools,test: lint doc-based addon tests
PR-URL: #5427 Fixes: #5424 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
1 parent 2043e6a commit e703b18

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

doc/api/addons.markdown

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ Once compiled, the example Addon can be required and used from within Node.js:
317317
// test.js
318318
const addon = require('./build/Release/addon');
319319
320-
console.log('This should be eight:', addon.add(3,5));
320+
console.log('This should be eight:', addon.add(3, 5));
321321
```
322322

323323

@@ -422,7 +422,7 @@ const addon = require('./build/Release/addon');
422422
423423
var obj1 = addon('hello');
424424
var obj2 = addon('world');
425-
console.log(obj1.msg+' '+obj2.msg); // 'hello world'
425+
console.log(obj1.msg + ' ' + obj2.msg); // 'hello world'
426426
```
427427

428428

@@ -637,9 +637,9 @@ Test it with:
637637
const addon = require('./build/Release/addon');
638638

639639
var obj = new addon.MyObject(10);
640-
console.log( obj.plusOne() ); // 11
641-
console.log( obj.plusOne() ); // 12
642-
console.log( obj.plusOne() ); // 13
640+
console.log(obj.plusOne()); // 11
641+
console.log(obj.plusOne()); // 12
642+
console.log(obj.plusOne()); // 13
643643
```
644644

645645
### Factory of wrapped objects
@@ -823,14 +823,14 @@ Test it with:
823823
const createObject = require('./build/Release/addon');
824824

825825
var obj = createObject(10);
826-
console.log( obj.plusOne() ); // 11
827-
console.log( obj.plusOne() ); // 12
828-
console.log( obj.plusOne() ); // 13
826+
console.log(obj.plusOne()); // 11
827+
console.log(obj.plusOne()); // 12
828+
console.log(obj.plusOne()); // 13
829829

830830
var obj2 = createObject(20);
831-
console.log( obj2.plusOne() ); // 21
832-
console.log( obj2.plusOne() ); // 22
833-
console.log( obj2.plusOne() ); // 23
831+
console.log(obj2.plusOne()); // 21
832+
console.log(obj2.plusOne()); // 22
833+
console.log(obj2.plusOne()); // 23
834834
```
835835

836836

tools/doc/addon-verify.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ function verifyFiles(files, blockName, onprogress, ondone) {
7171
);
7272

7373
files = Object.keys(files).map(function(name) {
74+
if (name === 'test.js') {
75+
files[name] = `'use strict';
76+
require('../../common');
77+
${files[name]}
78+
`;
79+
}
7480
return {
7581
path: path.resolve(dir, name),
7682
name: name,

0 commit comments

Comments
 (0)