mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
af273b5e81
Skip the doctool tests when js-yaml, which is currently `require()`d from the eslint source tree, is missing. This can happen, for example, because eslint is not included in the release source tarballs. Fixes: https://github.com/nodejs/node/issues/7201 Ref: https://github.com/nodejs/node/pull/6495 PR-URL: https://github.com/nodejs/node/pull/7218 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
104 lines
4.0 KiB
JavaScript
104 lines
4.0 KiB
JavaScript
'use strict';
|
|
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
// The doctool currently uses js-yaml from the tool/eslint/ tree.
|
|
try {
|
|
require('../../tools/eslint/node_modules/js-yaml');
|
|
} catch (e) {
|
|
return common.skip('missing js-yaml (eslint not present)');
|
|
}
|
|
|
|
const processIncludes = require('../../tools/doc/preprocess.js');
|
|
const html = require('../../tools/doc/html.js');
|
|
|
|
// Test data is a list of objects with two properties.
|
|
// The file property is the file path.
|
|
// The html property is some html which will be generated by the doctool.
|
|
// This html will be stripped of all whitespace because we don't currently
|
|
// have an html parser.
|
|
const testData = [
|
|
{
|
|
file: path.join(common.fixturesDir, 'sample_document.md'),
|
|
html: '<ol><li>fish</li><li><p>fish</p></li><li><p>Redfish</p></li>' +
|
|
'<li>Bluefish</li></ol>'
|
|
},
|
|
{
|
|
file: path.join(common.fixturesDir, 'order_of_end_tags_5873.md'),
|
|
html: '<h3>ClassMethod: Buffer.from(array) <span> ' +
|
|
'<a class="mark" href="#foo_class_method_buffer_from_array" ' +
|
|
'id="foo_class_method_buffer_from_array">#</a> </span> </h3><div' +
|
|
'class="signature"><ul><li><code>array</code><a ' +
|
|
'href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/' +
|
|
'Reference/Global_Objects/Array" class="type"><Array></a></li>' +
|
|
'</ul></div>'
|
|
},
|
|
{
|
|
file: path.join(common.fixturesDir, 'doc_with_yaml.md'),
|
|
html: '<h1>Sample Markdown with YAML info' +
|
|
'<span><a class="mark" href="#foo_sample_markdown_with_yaml_info" ' +
|
|
' id="foo_sample_markdown_with_yaml_info">#</a></span></h1>' +
|
|
'<h2>Foobar<span><a class="mark" href="#foo_foobar" ' +
|
|
'id="foo_foobar">#</a></span></h2>' +
|
|
'<div class="api_metadata"><span>Added in: v1.0.0</span></div> ' +
|
|
'<p>Describe <code>Foobar</code> in more detail here.</p>' +
|
|
'<h2>Foobar II<span><a class="mark" href="#foo_foobar_ii" ' +
|
|
'id="foo_foobar_ii">#</a></span></h2>' +
|
|
'<div class="api_metadata"><span>Added in: v5.3.0, v4.2.0</span></div> ' +
|
|
'<p>Describe <code>Foobar II</code> in more detail here.</p>' +
|
|
'<h2>Deprecated thingy<span><a class="mark" ' +
|
|
'href="#foo_deprecated_thingy" id="foo_deprecated_thingy">#</a>' +
|
|
'</span></h2>' +
|
|
'<div class="api_metadata"><span>Added in: v1.0.0</span>' +
|
|
'<span>Deprecated since: v2.0.0</span></div><p>Describe ' +
|
|
'<code>Deprecated thingy</code> in more detail here.</p>' +
|
|
'<h2>Something<span><a class="mark" href="#foo_something" ' +
|
|
'id="foo_something">#</a></span></h2> ' +
|
|
'<!-- This is not a metadata comment --> ' +
|
|
'<p>Describe <code>Something</code> in more detail here. ' +
|
|
'</p>'
|
|
},
|
|
{
|
|
file: path.join(common.fixturesDir, 'doc_with_includes.md'),
|
|
html: '<!-- [start-include:doc_inc_1.md] -->' +
|
|
'<p>Look <a href="doc_inc_2.html#doc_inc_2_foobar">here</a>!</p>' +
|
|
'<!-- [end-include:doc_inc_1.md] -->' +
|
|
'<!-- [start-include:doc_inc_2.md] -->' +
|
|
'<h1>foobar<span><a class="mark" href="#doc_inc_2_foobar" ' +
|
|
'id="doc_inc_2_foobar">#</a></span></h1>' +
|
|
'<p>I exist and am being linked to.</p>' +
|
|
'<!-- [end-include:doc_inc_2.md] -->'
|
|
},
|
|
];
|
|
|
|
testData.forEach(function(item) {
|
|
// Normalize expected data by stripping whitespace
|
|
const expected = item.html.replace(/\s/g, '');
|
|
|
|
fs.readFile(item.file, 'utf8', common.mustCall((err, input) => {
|
|
assert.ifError(err);
|
|
processIncludes(item.file, input, common.mustCall((err, preprocessed) => {
|
|
assert.ifError(err);
|
|
|
|
html(
|
|
{
|
|
input: preprocessed,
|
|
filename: 'foo',
|
|
template: 'doc/template.html',
|
|
nodeVersion: process.version,
|
|
},
|
|
common.mustCall((err, output) => {
|
|
assert.ifError(err);
|
|
|
|
const actual = output.replace(/\s/g, '');
|
|
// Assert that the input stripped of all whitespace contains the
|
|
// expected list
|
|
assert.notEqual(actual.indexOf(expected), -1);
|
|
}));
|
|
}));
|
|
}));
|
|
});
|