mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
662c2f96ed
This reads the fixture file and looks for ```js // Options: <JSON> ``` which it uses as the options for documentation.build and documentation.buildSync.
298 lines
9.5 KiB
JavaScript
298 lines
9.5 KiB
JavaScript
'use strict';
|
|
|
|
var test = require('tap').test,
|
|
documentationSchema = require('documentation-schema'),
|
|
validate = require('json-schema'),
|
|
documentation = require('../'),
|
|
outputMarkdown = require('../lib/output/markdown.js'),
|
|
outputMarkdownAST = require('../lib/output/markdown_ast.js'),
|
|
outputHtml = require('../lib/output/html.js'),
|
|
normalize = require('./normalize'),
|
|
glob = require('glob'),
|
|
path = require('path'),
|
|
fs = require('fs'),
|
|
_ = require('lodash'),
|
|
chdir = require('chdir');
|
|
|
|
var UPDATE = !!process.env.UPDATE;
|
|
|
|
function makePOJO(ast) {
|
|
return JSON.parse(JSON.stringify(ast));
|
|
}
|
|
|
|
function readOptionsFromFile(file) {
|
|
var s = fs.readFileSync(file, 'utf-8');
|
|
var lines = s.split(/\n/, 20);
|
|
for (var i = 0; i < lines.length; i++) {
|
|
var m = lines[i].match(/^\/\/\s+Options:\s*(.+)$/);
|
|
if (m) {
|
|
return JSON.parse(m[1]);
|
|
}
|
|
}
|
|
return {};
|
|
}
|
|
|
|
if (fs.existsSync(path.join(__dirname, '../.git'))) {
|
|
test('git option', function (t) {
|
|
var file = path.join(__dirname, './fixture/simple.input.js');
|
|
documentation.build([file], { github: true }, function (err, result) {
|
|
t.ifError(err);
|
|
normalize(result);
|
|
var outputfile = file.replace('.input.js', '.output.github.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
|
|
}
|
|
var expect = require(outputfile);
|
|
t.deepEqual(result, expect, 'produces correct JSON');
|
|
|
|
outputMarkdown(result, {}, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.github.md');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, result, 'utf8');
|
|
}
|
|
var expect = fs.readFileSync(outputfile, 'utf8');
|
|
t.equal(result.toString(), expect, 'markdown output correct');
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
test('external modules option', function (t) {
|
|
documentation.build([
|
|
path.join(__dirname, 'fixture', 'external.input.js')
|
|
], {
|
|
external: '(external|external/node_modules/*)'
|
|
}, function (err, result) {
|
|
t.ifError(err);
|
|
normalize(result);
|
|
var outputfile = path.join(__dirname, 'fixture', '_external-deps-included.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
|
|
}
|
|
var expect = require(outputfile);
|
|
t.deepEqual(result, expect);
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
test('bad input', function (tt) {
|
|
glob.sync(path.join(__dirname, 'fixture/bad', '*.input.js')).forEach(function (file) {
|
|
tt.test(path.basename(file), function (t) {
|
|
documentation.build([file], readOptionsFromFile(file), function (error, res) {
|
|
t.equal(res, undefined);
|
|
// make error a serializable object
|
|
error = JSON.parse(JSON.stringify(error));
|
|
// remove system-specific path
|
|
delete error.filename;
|
|
delete error.codeFrame;
|
|
var outputfile = file.replace('.input.js', '.output.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(error, null, 2));
|
|
}
|
|
var expect = JSON.parse(fs.readFileSync(outputfile));
|
|
t.deepEqual(error, expect);
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
tt.end();
|
|
});
|
|
|
|
test('html', function (tt) {
|
|
glob.sync(path.join(__dirname, 'fixture/html', '*.input.js')).forEach(function (file) {
|
|
tt.test(path.basename(file), function (t) {
|
|
documentation.build([file], readOptionsFromFile(file), function (err, result) {
|
|
t.ifError(err);
|
|
outputHtml(result, null, function (err, result) {
|
|
t.ifError(err);
|
|
var clean = result.sort(function (a, b) {
|
|
return a.path > b.path;
|
|
}).filter(function (r) {
|
|
return r.path.match(/(html)$/);
|
|
}).map(function (r) {
|
|
return r.contents;
|
|
}).join('\n');
|
|
var outputfile = file.replace('.input.js', '.output.files');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, clean, 'utf8');
|
|
}
|
|
var expect = fs.readFileSync(outputfile, 'utf8');
|
|
t.deepEqual(clean, expect);
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
});
|
|
tt.end();
|
|
});
|
|
|
|
test('outputs', function (ttt) {
|
|
glob.sync(path.join(__dirname, 'fixture', '*.input.js')).forEach(function (file) {
|
|
ttt.test(path.basename(file), function (tt) {
|
|
documentation.build([file], readOptionsFromFile(file), function (err, result) {
|
|
tt.ifError(err);
|
|
|
|
tt.test('markdown', function (t) {
|
|
outputMarkdown(_.cloneDeep(result), {}, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.md');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, result, 'utf8');
|
|
}
|
|
var expect = fs.readFileSync(outputfile, 'utf8');
|
|
t.equal(result.toString(), expect, 'markdown output correct');
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
tt.test('markdown AST', function (t) {
|
|
outputMarkdownAST(_.cloneDeep(result), {}, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.md.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2), 'utf8');
|
|
}
|
|
var expect = JSON.parse(fs.readFileSync(outputfile, 'utf8'));
|
|
t.deepEqual(result, expect, 'markdown AST output correct');
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
tt.test('JSON', function (t) {
|
|
normalize(result);
|
|
result.forEach(function (comment) {
|
|
validate(comment, documentationSchema.jsonSchema).errors.forEach(function (error) {
|
|
t.ifError(error);
|
|
});
|
|
});
|
|
var outputfile = file.replace('.input.js', '.output.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
|
|
}
|
|
var expect = require(outputfile);
|
|
t.deepEqual(makePOJO(result), expect);
|
|
t.end();
|
|
});
|
|
|
|
tt.end();
|
|
});
|
|
});
|
|
});
|
|
ttt.end();
|
|
});
|
|
|
|
test('outputs - sync', function (ttt) {
|
|
glob.sync(path.join(__dirname, 'fixture/sync', '*.input.js')).forEach(function (file) {
|
|
ttt.test(path.basename(file), function (tt) {
|
|
var result = documentation.buildSync([file], readOptionsFromFile(file));
|
|
|
|
tt.test('markdown', function (t) {
|
|
outputMarkdown(result, {}, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.md');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, result, 'utf8');
|
|
}
|
|
var expect = fs.readFileSync(outputfile, 'utf8');
|
|
t.equal(result.toString(), expect, 'markdown output correct');
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
tt.test('markdown AST', function (t) {
|
|
outputMarkdownAST(result, {}, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.md.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2), 'utf8');
|
|
}
|
|
var expect = JSON.parse(fs.readFileSync(outputfile, 'utf8'));
|
|
t.deepEqual(result, expect, 'markdown AST output correct');
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
tt.test('JSON', function (t) {
|
|
normalize(result);
|
|
var outputfile = file.replace('.input.js', '.output.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
|
|
}
|
|
var expect = require(outputfile);
|
|
t.deepEqual(makePOJO(result), expect);
|
|
t.end();
|
|
});
|
|
|
|
tt.end();
|
|
});
|
|
});
|
|
ttt.end();
|
|
});
|
|
|
|
test('highlightAuto md output', function (t) {
|
|
var file = path.join(__dirname, 'fixture/auto_lang_hljs/multilanguage.input.js'),
|
|
hljsConfig = {hljs: {highlightAuto: true, languages: ['js', 'css', 'html']}};
|
|
|
|
documentation.build(file, null, function (err, result) {
|
|
t.ifError(err);
|
|
outputMarkdown(result, hljsConfig, function (err, result) {
|
|
t.ifError(err);
|
|
var outputfile = file.replace('.input.js', '.output.md');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, result, 'utf8');
|
|
}
|
|
var expect = fs.readFileSync(outputfile, 'utf8');
|
|
t.equal(result.toString(), expect, 'recognizes examples in html, css and js');
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
|
|
test('multi-file input', function (t) {
|
|
documentation.build([
|
|
path.join(__dirname, 'fixture', 'simple.input.js'),
|
|
path.join(__dirname, 'fixture', 'simple-two.input.js')
|
|
], null, function (err, result) {
|
|
t.ifError(err);
|
|
normalize(result);
|
|
var outputfile = path.join(__dirname, 'fixture', '_multi-file-input.json');
|
|
if (UPDATE) {
|
|
fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
|
|
}
|
|
var expect = require(outputfile);
|
|
t.deepEqual(result, expect);
|
|
t.end();
|
|
});
|
|
});
|
|
|
|
test('accepts simple relative paths', function (t) {
|
|
chdir(__dirname, function () {
|
|
documentation.build('fixture/simple.input.js', null, function (err, data) {
|
|
t.ifError(err);
|
|
t.equal(data.length, 1, 'simple has no dependencies');
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
|
|
test('.lint', function (t) {
|
|
chdir(__dirname, function () {
|
|
documentation.lint('fixture/simple.input.js', null, function (err, data) {
|
|
t.ifError(err);
|
|
t.equal(data, '', 'outputs lint information');
|
|
t.end();
|
|
});
|
|
});
|
|
});
|
|
|
|
test('.lint with bad input', function (t) {
|
|
chdir(__dirname, function () {
|
|
documentation.lint('fixture/bad/syntax.input.js', null, function (err, data) {
|
|
t.ok(err, 'returns an error when syntax is incorrect');
|
|
t.end();
|
|
});
|
|
});
|
|
});
|