Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tools: apply linting to doc tools #4973

Closed
wants to merge 2 commits into from
Closed

tools: apply linting to doc tools #4973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7441d4e
tools: apply linting to doc tools
Trott Jan 30, 2016
d9a345e
fixup: update vcbuild.bat too
Trott Jan 31, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ test/fixtures
test/**/node_modules
test/disabled
test/tmp*/
tools/doc/node_modules
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ bench-idle:
$(NODE) benchmark/idle_clients.js &

jslint:
$(NODE) tools/eslint/bin/eslint.js src lib test tools/eslint-rules \
$(NODE) tools/eslint/bin/eslint.js lib src test tools/doc tools/eslint-rules \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You also need to update the corresponding line in vcbuild.bat

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, of course! Done! (If someone on a Windows machine can confirm that it still works on Windows, that would be great. I don't think we run lint on Windows in CI.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great (Win10)

--rulesdir tools/eslint-rules --quiet

CPPLINT_EXCLUDE ?=
Expand Down
19 changes: 13 additions & 6 deletions tools/doc/addon-verify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ const fs = require('fs');
const path = require('path');
const marked = require('marked');

const doc = path.resolve(__dirname, '..', '..', 'doc', 'api', 'addons.markdown');
const verifyDir = path.resolve(__dirname, '..', '..', 'test', 'addons');
const rootDir = path.resolve(__dirname, '..', '..');
const doc = path.resolve(rootDir, 'doc', 'api', 'addons.markdown');
const verifyDir = path.resolve(rootDir, 'test', 'addons');

const contents = fs.readFileSync(doc).toString();

let tokens = marked.lexer(contents, {});
const tokens = marked.lexer(contents, {});
let files = null;
let blockName;
let id = 0;
Expand All @@ -27,7 +28,7 @@ oldDirs = oldDirs.filter(function(dir) {
for (var i = 0; i < tokens.length; i++) {
var token = tokens[i];
if (token.type === 'heading' && token.text) {
blockName = token.text
blockName = token.text;
if (files && Object.keys(files).length !== 0) {
verifyFiles(files,
blockName,
Expand Down Expand Up @@ -60,8 +61,14 @@ function verifyFiles(files, blockName, onprogress, ondone) {
return;
}

blockName = blockName.toLowerCase().replace(/\s/g, '_').replace(/[^a-z\d_]/g, '')
let dir = path.resolve(verifyDir, `${(++id < 10 ? '0' : '') + id}_${blockName}`);
blockName = blockName
.toLowerCase()
.replace(/\s/g, '_')
.replace(/[^a-z\d_]/g, '');
const dir = path.resolve(
verifyDir,
`${(++id < 10 ? '0' : '') + id}_${blockName}`
);

files = Object.keys(files).map(function(name) {
return {
Expand Down
10 changes: 4 additions & 6 deletions tools/doc/generate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict';

var processIncludes = require('./preprocess.js');
var marked = require('marked');
var fs = require('fs');
var path = require('path');

// parse the args.
// Don't use nopt or whatever for this. It's simple enough.
Expand All @@ -11,15 +11,15 @@ var format = 'json';
var template = null;
var inputFile = null;

args.forEach(function (arg) {
args.forEach(function(arg) {
if (!arg.match(/^\-\-/)) {
inputFile = arg;
} else if (arg.match(/^\-\-format=/)) {
format = arg.replace(/^\-\-format=/, '');
} else if (arg.match(/^\-\-template=/)) {
template = arg.replace(/^\-\-template=/, '');
}
})
});


if (!inputFile) {
Expand All @@ -35,8 +35,6 @@ fs.readFile(inputFile, 'utf8', function(er, input) {
});




function next(er, input) {
if (er) throw er;
switch (format) {
Expand Down
20 changes: 15 additions & 5 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
'use strict';

var fs = require('fs');
var marked = require('marked');
var path = require('path');
Expand All @@ -6,7 +8,14 @@ var preprocess = require('./preprocess.js');
module.exports = toHTML;

// TODO(chrisdickinson): never stop vomitting / fix this.
var gtocPath = path.resolve(path.join(__dirname, '..', '..', 'doc', 'api', '_toc.markdown'));
var gtocPath = path.resolve(path.join(
__dirname,
'..',
'..',
'doc',
'api',
'_toc.markdown'
));
var gtocLoading = null;
var gtocData = null;

Expand Down Expand Up @@ -55,7 +64,10 @@ function loadGtoc(cb) {
}

function toID(filename) {
return filename.replace('.html', '').replace(/[^\w\-]/g, '-').replace(/-+/g, '-');
return filename
.replace('.html', '')
.replace(/[^\w\-]/g, '-')
.replace(/-+/g, '-');
}

function render(lexed, filename, template, cb) {
Expand Down Expand Up @@ -85,7 +97,7 @@ function render(lexed, filename, template, cb) {

// content has to be the last thing we do with
// the lexed tokens, because it's destructive.
content = marked.parser(lexed);
const content = marked.parser(lexed);
template = template.replace(/__CONTENT__/g, content);

cb(null, template);
Expand Down Expand Up @@ -173,7 +185,6 @@ function parseAPIHeader(text) {

// section is just the first heading
function getSection(lexed) {
var section = '';
for (var i = 0, l = lexed.length; i < l; i++) {
var tok = lexed[i];
if (tok.type === 'heading') return tok.text;
Expand All @@ -183,7 +194,6 @@ function getSection(lexed) {


function buildToc(lexed, filename, cb) {
var indent = 0;
var toc = [];
var depth = 0;
lexed.forEach(function(tok) {
Expand Down
22 changes: 12 additions & 10 deletions tools/doc/json.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
'use strict';

module.exports = doJSON;

// Take the lexed input, and return a JSON-encoded object
Expand All @@ -12,7 +14,7 @@ function doJSON(input, filename, cb) {
var current = root;
var state = null;
var lexed = marked.lexer(input);
lexed.forEach(function (tok) {
lexed.forEach(function(tok) {
var type = tok.type;
var text = tok.text;

Expand All @@ -31,7 +33,7 @@ function doJSON(input, filename, cb) {
if (type === 'heading' &&
!text.trim().match(/^example/i)) {
if (tok.depth - depth > 1) {
return cb(new Error('Inappropriate heading level\n'+
return cb(new Error('Inappropriate heading level\n' +
JSON.stringify(tok)));
}

Expand Down Expand Up @@ -77,7 +79,7 @@ function doJSON(input, filename, cb) {
//
// If one of these isnt' found, then anything that comes between
// here and the next heading should be parsed as the desc.
var stability
var stability;
if (state === 'AFTERHEADING') {
if (type === 'code' &&
(stability = text.match(/^Stability: ([0-5])(?:\s*-\s*)?(.*)$/))) {
Expand Down Expand Up @@ -125,7 +127,7 @@ function doJSON(input, filename, cb) {
finishSection(current, stack[stack.length - 1]);
}

return cb(null, root)
return cb(null, root);
}


Expand All @@ -146,7 +148,7 @@ function doJSON(input, filename, cb) {
// { type: 'list_item_end' },
// { type: 'list_item_start' },
// { type: 'text',
// text: 'silent: Boolean, whether or not to send output to parent\'s stdio.' },
// text: 'silent: Boolean, whether to send output to parent\'s stdio.' },
// { type: 'text', text: 'Default: `false`' },
// { type: 'space' },
// { type: 'list_item_end' },
Expand All @@ -168,7 +170,7 @@ function doJSON(input, filename, cb) {
// desc: 'string arguments passed to worker.' },
// { name: 'silent',
// type: 'boolean',
// desc: 'whether or not to send output to parent\'s stdio.',
// desc: 'whether to send output to parent\'s stdio.',
// default: 'false' } ] } ]

function processList(section) {
Expand Down Expand Up @@ -231,7 +233,7 @@ function processList(section) {
// each item is an argument, unless the name is 'return',
// in which case it's the return value.
section.signatures = section.signatures || [];
var sig = {}
var sig = {};
section.signatures.push(sig);
sig.params = values.filter(function(v) {
if (v.name === 'return') {
Expand Down Expand Up @@ -273,7 +275,7 @@ function parseSignature(text, sig) {
params = params[1];
// the [ is irrelevant. ] indicates optionalness.
params = params.replace(/\[/g, '');
params = params.split(/,/)
params = params.split(/,/);
params.forEach(function(p, i, _) {
p = p.trim();
if (!p) return;
Expand Down Expand Up @@ -362,7 +364,7 @@ function parseListItem(item) {

function finishSection(section, parent) {
if (!section || !parent) {
throw new Error('Invalid finishSection call\n'+
throw new Error('Invalid finishSection call\n' +
JSON.stringify(section) + '\n' +
JSON.stringify(parent));
}
Expand Down Expand Up @@ -405,7 +407,7 @@ function finishSection(section, parent) {
// properties are a bit special.
// their "type" is the type of object, not "property"
if (section.properties) {
section.properties.forEach(function (p) {
section.properties.forEach(function(p) {
if (p.typeof) p.type = p.typeof;
else delete p.type;
delete p.typeof;
Expand Down
6 changes: 4 additions & 2 deletions tools/doc/preprocess.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
'use strict';

module.exports = preprocess;

var path = require('path');
Expand All @@ -8,7 +10,7 @@ var includeData = {};

function preprocess(inputFile, input, cb) {
input = stripComments(input);
processIncludes(inputFile, input, function (err, data) {
processIncludes(inputFile, input, function(err, data) {
if (err) return cb(err);

cb(null, data);
Expand Down Expand Up @@ -47,7 +49,7 @@ function processIncludes(inputFile, input, cb) {
if (er) return cb(errState = er);
incCount--;
includeData[fname] = inc;
input = input.split(include+'\n').join(includeData[fname]+'\n');
input = input.split(include + '\n').join(includeData[fname] + '\n');
if (incCount === 0) {
return cb(null, input);
}
Expand Down
2 changes: 1 addition & 1 deletion vcbuild.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ goto jslint
:jslint
if not defined jslint goto exit
echo running jslint
%config%\node tools\eslint\bin\eslint.js src lib test tools\eslint-rules --rulesdir tools\eslint-rules --quiet
%config%\node tools\eslint\bin\eslint.js lib src test tools\doc tools\eslint-rules --rulesdir tools\eslint-rules --quiet
goto exit

:create-msvs-files-failed
Expand Down