mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
80 lines
2.6 KiB
JavaScript
80 lines
2.6 KiB
JavaScript
|
|
'use strict';
|
|
/* @flow */
|
|
|
|
var mdeps = require('module-deps-sortable');
|
|
var path = require('path');
|
|
var babelify = require('babelify');
|
|
var concat = require('concat-stream');
|
|
var moduleFilters = require('../../lib/module_filters');
|
|
var smartGlob = require('../smart_glob.js');
|
|
|
|
/**
|
|
* Returns a readable stream of dependencies, given an array of entry
|
|
* points and an object of options to provide to module-deps.
|
|
*
|
|
* This stream requires filesystem access, and thus isn't suitable
|
|
* for a browser environment.
|
|
*
|
|
* @param indexes paths to entry files as strings
|
|
* @param config optional options passed
|
|
* @returns results
|
|
*/
|
|
function dependencyStream(indexes/*: Array<string>*/,
|
|
config/*: DocumentationConfig */)/*: Promise<Array<SourceFile>>*/ {
|
|
var md = mdeps({
|
|
/**
|
|
* Determine whether a module should be included in documentation
|
|
* @param {string} id path to a module
|
|
* @returns {boolean} true if the module should be included.
|
|
*/
|
|
filter: id => !!config.external || moduleFilters.internalOnly(id),
|
|
extensions: [].concat(config.requireExtension || [])
|
|
.map(ext => '.' + ext.replace(/^\./, ''))
|
|
.concat(['.js', '.json', '.es6', '.jsx']),
|
|
transform: [babelify.configure({
|
|
sourceMap: false,
|
|
compact: false,
|
|
presets: [
|
|
require('babel-preset-es2015'),
|
|
require('babel-preset-stage-0'),
|
|
require('babel-preset-react')
|
|
],
|
|
plugins: [
|
|
require('babel-plugin-transform-decorators-legacy').default,
|
|
// Required to support webpack's System.import
|
|
// https://github.com/documentationjs/documentation/issues/578
|
|
require('babel-plugin-system-import-transformer').default
|
|
]
|
|
})],
|
|
postFilter: moduleFilters.externals(indexes, config)
|
|
});
|
|
smartGlob(indexes, config.parseExtension).forEach(index => {
|
|
md.write(path.resolve(index));
|
|
});
|
|
md.end();
|
|
|
|
return new Promise((resolve, reject) => {
|
|
md.once('error', reject);
|
|
md.pipe(concat(function (inputs) {
|
|
resolve(inputs
|
|
.filter(input =>
|
|
// At this point, we may have allowed a JSON file to be caught by
|
|
// module-deps, or anything else allowed by requireExtension.
|
|
// otherwise module-deps would complain about
|
|
// it not being found. But Babel can't parse JSON, so we filter non-JavaScript
|
|
// files away.
|
|
config.parseExtension.indexOf(
|
|
path.extname(input.file).replace(/^\./, '')
|
|
) > -1)
|
|
.map(input => {
|
|
// remove source file, since it's transformed anyway
|
|
delete input.source;
|
|
return input;
|
|
}));
|
|
}));
|
|
});
|
|
}
|
|
|
|
module.exports = dependencyStream;
|