mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
9190e4ecdf
1. Move the apilinks.json file into out/doc so it gets cleaned when running `make docclean` 2. When the apilinks.json generated is empty, throw a specific error so it's easier to understand what's wrong 3. Write to a file passed through CLI arguments instead writing to stdout in apilinks.js so the build process is more robust in the case of a bad binary PR-URL: https://github.com/nodejs/node/pull/25019 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@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 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('--output-directory=')) {
|
|
outputDir = arg.replace(/^--output-directory=/, '');
|
|
} else if (arg.startsWith('--apilinks=')) {
|
|
const linkFile = arg.replace(/^--apilinks=/, '');
|
|
const data = fs.readFileSync(linkFile, 'utf8');
|
|
if (!data.trim()) {
|
|
throw new Error(`${linkFile} is empty`);
|
|
}
|
|
apilinks = JSON.parse(data);
|
|
}
|
|
});
|
|
|
|
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 },
|
|
(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));
|
|
});
|