Skip to content

Commit ff988b3

Browse files
Trottrvagg
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 22bb7c9 commit ff988b3

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
@@ -318,7 +318,7 @@ Once compiled, the example Addon can be required and used from within Node.js:
318318
// test.js
319319
const addon = require('./build/Release/addon');
320320
321-
console.log('This should be eight:', addon.add(3,5));
321+
console.log('This should be eight:', addon.add(3, 5));
322322
```
323323

324324

@@ -423,7 +423,7 @@ const addon = require('./build/Release/addon');
423423
424424
var obj1 = addon('hello');
425425
var obj2 = addon('world');
426-
console.log(obj1.msg+' '+obj2.msg); // 'hello world'
426+
console.log(obj1.msg + ' ' + obj2.msg); // 'hello world'
427427
```
428428

429429

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

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

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

826826
var obj = createObject(10);
827-
console.log( obj.plusOne() ); // 11
828-
console.log( obj.plusOne() ); // 12
829-
console.log( obj.plusOne() ); // 13
827+
console.log(obj.plusOne()); // 11
828+
console.log(obj.plusOne()); // 12
829+
console.log(obj.plusOne()); // 13
830830

831831
var obj2 = createObject(20);
832-
console.log( obj2.plusOne() ); // 21
833-
console.log( obj2.plusOne() ); // 22
834-
console.log( obj2.plusOne() ); // 23
832+
console.log(obj2.plusOne()); // 21
833+
console.log(obj2.plusOne()); // 22
834+
console.log(obj2.plusOne()); // 23
835835
```
836836

837837

tools/doc/addon-verify.js

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

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

0 commit comments

Comments
 (0)