mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
60465700ed
Parse source code using acorn; extracting exports. When producing documentation, match exports to headers. When a match is found, add a [src] link. This first commit handles simple exported classes and functions, and does so without requiring any changes to the source code or markdown. Subsequent commits will attempt to match more headers, and some of these changes are likely to require changes to the source code and/or markdown. PR-URL: https://github.com/nodejs/node/pull/22405 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
99 lines
3.2 KiB
JavaScript
99 lines
3.2 KiB
JavaScript
// Copyright Joyent, Inc. and other Node contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the
|
|
// "Software"), to deal in the Software without restriction, including
|
|
// without limitation the rights to use, copy, modify, merge, publish,
|
|
// distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
// persons to whom the Software is furnished to do so, subject to the
|
|
// following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included
|
|
// in all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
|
|
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
|
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
// USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
'use strict';
|
|
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const unified = require('unified');
|
|
const markdown = require('remark-parse');
|
|
const remark2rehype = require('remark-rehype');
|
|
const raw = require('rehype-raw');
|
|
const htmlStringify = require('rehype-stringify');
|
|
|
|
const html = require('./html');
|
|
const json = require('./json');
|
|
|
|
// Parse the args.
|
|
// Don't use nopt or whatever for this. It's simple enough.
|
|
|
|
const args = process.argv.slice(2);
|
|
let filename = null;
|
|
let nodeVersion = null;
|
|
let analytics = null;
|
|
let outputDir = null;
|
|
let apilinks = {};
|
|
|
|
args.forEach(function(arg) {
|
|
if (!arg.startsWith('--')) {
|
|
filename = arg;
|
|
} else if (arg.startsWith('--node-version=')) {
|
|
nodeVersion = arg.replace(/^--node-version=/, '');
|
|
} else if (arg.startsWith('--analytics=')) {
|
|
analytics = arg.replace(/^--analytics=/, '');
|
|
} else if (arg.startsWith('--output-directory=')) {
|
|
outputDir = arg.replace(/^--output-directory=/, '');
|
|
} else if (arg.startsWith('--apilinks=')) {
|
|
apilinks = JSON.parse(
|
|
fs.readFileSync(arg.replace(/^--apilinks=/, ''), 'utf8')
|
|
);
|
|
}
|
|
});
|
|
|
|
nodeVersion = nodeVersion || process.version;
|
|
|
|
if (!filename) {
|
|
throw new Error('No input file specified');
|
|
} else if (!outputDir) {
|
|
throw new Error('No output directory specified');
|
|
}
|
|
|
|
|
|
fs.readFile(filename, 'utf8', (er, input) => {
|
|
if (er) throw er;
|
|
|
|
const content = unified()
|
|
.use(markdown)
|
|
.use(html.preprocessText)
|
|
.use(json.jsonAPI, { filename })
|
|
.use(html.firstHeader)
|
|
.use(html.preprocessElements, { filename })
|
|
.use(html.buildToc, { filename, apilinks })
|
|
.use(remark2rehype, { allowDangerousHTML: true })
|
|
.use(raw)
|
|
.use(htmlStringify)
|
|
.processSync(input);
|
|
|
|
const basename = path.basename(filename, '.md');
|
|
|
|
html.toHTML(
|
|
{ input, content, filename, nodeVersion, analytics },
|
|
(err, html) => {
|
|
const target = path.join(outputDir, `${basename}.html`);
|
|
if (err) throw err;
|
|
fs.writeFileSync(target, html);
|
|
}
|
|
);
|
|
|
|
const target = path.join(outputDir, `${basename}.json`);
|
|
fs.writeFileSync(target, JSON.stringify(content.json, null, 2));
|
|
});
|