Browse Source

test: use addon.md block headings as test dir names

instead of doc-*

PR-URL: https://github.com/nodejs/node/pull/4412
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
v4.x
Rod Vagg 9 years ago
committed by Myles Borins
parent
commit
e6448aa36b
  1. 2
      .eslintignore
  2. 2
      .gitignore
  3. 6
      Makefile
  4. 34
      tools/doc/addon-verify.js

2
.eslintignore

@ -1,5 +1,5 @@
lib/punycode.js lib/punycode.js
test/addons/doc-*/ test/addons/??_*/
test/fixtures test/fixtures
test/**/node_modules test/**/node_modules
test/disabled test/disabled

2
.gitignore

@ -50,7 +50,7 @@ ipch/
/npm.wxs /npm.wxs
/tools/msvs/npm.wixobj /tools/msvs/npm.wixobj
/tools/osx-pkg.pmdoc/index.xml /tools/osx-pkg.pmdoc/index.xml
/test/addons/doc-*/ /test/addons/??_*/
email.md email.md
deps/v8-* deps/v8-*
deps/icu deps/icu

6
Makefile

@ -105,12 +105,12 @@ test/gc/node_modules/weak/build/Release/weakref.node: $(NODE_EXE)
# Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale. # Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
test/addons/.docbuildstamp: doc/api/addons.markdown test/addons/.docbuildstamp: doc/api/addons.markdown
$(RM) -r test/addons/doc-*/ $(RM) -r test/addons/??_*/
$(NODE) tools/doc/addon-verify.js $(NODE) tools/doc/addon-verify.js
touch $@ touch $@
ADDONS_BINDING_GYPS := \ ADDONS_BINDING_GYPS := \
$(filter-out test/addons/doc-*/binding.gyp, \ $(filter-out test/addons/??_*/binding.gyp, \
$(wildcard test/addons/*/binding.gyp)) $(wildcard test/addons/*/binding.gyp))
# Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale. # Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
@ -520,7 +520,7 @@ CPPLINT_EXCLUDE += src/node_win32_perfctr_provider.cc
CPPLINT_EXCLUDE += src/queue.h CPPLINT_EXCLUDE += src/queue.h
CPPLINT_EXCLUDE += src/tree.h CPPLINT_EXCLUDE += src/tree.h
CPPLINT_EXCLUDE += src/v8abbr.h CPPLINT_EXCLUDE += src/v8abbr.h
CPPLINT_EXCLUDE += $(wildcard test/addons/doc-*/*.cc test/addons/doc-*/*.h) CPPLINT_EXCLUDE += $(wildcard test/addons/??_*/*.cc test/addons/??_*/*.h)
CPPLINT_FILES = $(filter-out $(CPPLINT_EXCLUDE), $(wildcard \ CPPLINT_FILES = $(filter-out $(CPPLINT_EXCLUDE), $(wildcard \
deps/debugger-agent/include/* \ deps/debugger-agent/include/* \

34
tools/doc/addon-verify.js

@ -1,31 +1,36 @@
var fs = require('fs'); 'use strict';
var path = require('path');
var marked = require('marked');
var doc = path.resolve(__dirname, '..', '..', 'doc', 'api', 'addons.markdown'); const fs = require('fs');
var verifyDir = path.resolve(__dirname, '..', '..', 'test', 'addons'); const path = require('path');
const marked = require('marked');
var contents = fs.readFileSync(doc).toString(); const doc = path.resolve(__dirname, '..', '..', 'doc', 'api', 'addons.markdown');
const verifyDir = path.resolve(__dirname, '..', '..', 'test', 'addons');
var tokens = marked.lexer(contents, {}); const contents = fs.readFileSync(doc).toString();
var files = null;
var id = 0; let tokens = marked.lexer(contents, {});
let files = null;
let blockName;
let id = 0;
// Just to make sure that all examples will be processed // Just to make sure that all examples will be processed
tokens.push({ type: 'heading' }); tokens.push({ type: 'heading' });
var oldDirs = fs.readdirSync(verifyDir); var oldDirs = fs.readdirSync(verifyDir);
oldDirs = oldDirs.filter(function(dir) { oldDirs = oldDirs.filter(function(dir) {
return /^doc-/.test(dir); return /^\d{2}_/.test(dir);
}).map(function(dir) { }).map(function(dir) {
return path.resolve(verifyDir, dir); return path.resolve(verifyDir, dir);
}); });
for (var i = 0; i < tokens.length; i++) { for (var i = 0; i < tokens.length; i++) {
var token = tokens[i]; var token = tokens[i];
if (token.type === 'heading') { if (token.type === 'heading' && token.text) {
blockName = token.text
if (files && Object.keys(files).length !== 0) { if (files && Object.keys(files).length !== 0) {
verifyFiles(files, verifyFiles(files,
blockName,
console.log.bind(null, 'wrote'), console.log.bind(null, 'wrote'),
function(err) { if (err) throw err; }); function(err) { if (err) throw err; });
} }
@ -48,15 +53,16 @@ function once(fn) {
}; };
} }
function verifyFiles(files, onprogress, ondone) { function verifyFiles(files, blockName, onprogress, ondone) {
var dir = path.resolve(verifyDir, 'doc-' + id++);
// must have a .cc and a .js to be a valid test // must have a .cc and a .js to be a valid test
if (!Object.keys(files).some((name) => /\.cc$/.test(name)) || if (!Object.keys(files).some((name) => /\.cc$/.test(name)) ||
!Object.keys(files).some((name) => /\.js$/.test(name))) { !Object.keys(files).some((name) => /\.js$/.test(name))) {
return; return;
} }
blockName = blockName.toLowerCase().replace(/\s/g, '_').replace(/[^a-z\d_]/g, '')
let dir = path.resolve(verifyDir, `${(++id < 10 ? '0' : '') + id}_${blockName}`);
files = Object.keys(files).map(function(name) { files = Object.keys(files).map(function(name) {
return { return {
path: path.resolve(dir, name), path: path.resolve(dir, name),

Loading…
Cancel
Save