Skip to content

Commit

Permalink
Revert "build,tools: check freshness of doc addons"
Browse files Browse the repository at this point in the history
This reverts commit 2cb9e2a.

Reverted along with d9b59de as this introduces freshness checks that
are too stringent without the comprehensive dependency checking of
introduced in d9b59de so `make test` won't work with this.

Ref: nodejs#17407
PR-URL: nodejs#18287
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
  • Loading branch information
rvagg committed Jan 24, 2018
1 parent b886c42 commit d5d024d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 27 deletions.
6 changes: 1 addition & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ v8:

.PHONY: test
# This does not run tests of third-party libraries inside deps.
test: all check-doc-addons build-addons ## Runs default tests, linters, and builds docs.
test: all build-addons ## Runs default tests, linters, and builds docs.
$(MAKE) -s doc-only
$(MAKE) -s lint
$(MAKE) -s cctest
Expand All @@ -234,10 +234,6 @@ test: all check-doc-addons build-addons ## Runs default tests, linters, and buil
$(CI_NATIVE_SUITES) \
$(CI_DOC)

.PHONY: check-doc-addons
check-doc-addons: $(NODE)
$(NODE) tools/doc/addon-verify.js --check

.PHONY: test-only
test-only: all build-addons ## For a quick test, does not run linter or build docs.
$(MAKE) cctest
Expand Down
31 changes: 9 additions & 22 deletions tools/doc/addon-verify.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ const rootDir = path.resolve(__dirname, '..', '..');
const doc = path.resolve(rootDir, 'doc', 'api', 'addons.md');
const verifyDir = path.resolve(rootDir, 'test', 'addons');

const changed = [];
const checkOnly = process.argv.includes('--check');

let id = 0;
let currentHeader;

Expand Down Expand Up @@ -79,6 +76,12 @@ for (const header in addons) {
})
});

try {
fs.mkdirSync(dir);
} catch (e) {
strictEqual(e.code, 'EEXIST');
}

for (const file of files) {
let content;
try {
Expand All @@ -88,29 +91,13 @@ for (const header in addons) {
}

// Only update when file content has changed to prevent unneeded rebuilds.
if (content === file.content) continue;
changed.push(file);

if (checkOnly) continue;

try {
fs.mkdirSync(dir);
} catch (e) {
strictEqual(e.code, 'EEXIST');
if (content !== file.content) {
fs.writeFileSync(file.path, file.content);
console.log('wrote', file.path);
}

fs.writeFileSync(file.path, file.content);
console.log('wrote', file.path);
}
}

if (checkOnly && changed.length > 0) {
console.error('The following files are out of date:');
for (const { path } of changed) console.error(' ', path);
console.error('Run `node tools/doc/addon-verify.js` to update.');
process.exit(1);
}

function boilerplate(name, content) {
return `'use strict';
const common = require('../../common');
Expand Down

0 comments on commit d5d024d

Please sign in to comment.