mirror of
https://github.com/nodejs/node.git
synced 2025-05-04 18:29:54 +00:00
0c743b5f77
Notes: 1) Removed a number of root properties that did not seem relevant: source, desc, and introduced_in. There no longer is a source, and the other two are from the first include and do not reflect the entire API. 2) As with https://github.com/nodejs/node/issues/20100, the current "desc" properties sometimes contained in-page links, other times referenced another page, and often did not match the links in the original HTML or JSON file. I chose to standardize on external links as "desc" values are isolated snippets as opposed to all.html which can be viewed as a standalone and self contained document. 3) Eliminated preprocessing for @include entirely, including the test case for this function. 4) _toc.md was renamed to index.md. 5) index comments no longer appear in embedded TOCs (left hand side column in the generated documentation. PR-URL: https://github.com/nodejs/node/pull/21637 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
75 lines
2.4 KiB
JavaScript
75 lines
2.4 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');
|
|
|
|
// Parse the args.
|
|
// Don't use nopt or whatever for this. It's simple enough.
|
|
|
|
const args = process.argv.slice(2);
|
|
let format = 'json';
|
|
let filename = null;
|
|
let nodeVersion = null;
|
|
let analytics = null;
|
|
|
|
args.forEach(function(arg) {
|
|
if (!arg.startsWith('--')) {
|
|
filename = arg;
|
|
} else if (arg.startsWith('--format=')) {
|
|
format = arg.replace(/^--format=/, '');
|
|
} else if (arg.startsWith('--node-version=')) {
|
|
nodeVersion = arg.replace(/^--node-version=/, '');
|
|
} else if (arg.startsWith('--analytics=')) {
|
|
analytics = arg.replace(/^--analytics=/, '');
|
|
}
|
|
});
|
|
|
|
nodeVersion = nodeVersion || process.version;
|
|
|
|
if (!filename) {
|
|
throw new Error('No input file specified');
|
|
}
|
|
|
|
fs.readFile(filename, 'utf8', (er, input) => {
|
|
if (er) throw er;
|
|
switch (format) {
|
|
case 'json':
|
|
require('./json.js')(input, filename, (er, obj) => {
|
|
if (er) throw er;
|
|
console.log(JSON.stringify(obj, null, 2));
|
|
});
|
|
break;
|
|
|
|
case 'html':
|
|
require('./html')({ input, filename, nodeVersion, analytics },
|
|
(err, html) => {
|
|
if (err) throw err;
|
|
console.log(html);
|
|
});
|
|
break;
|
|
|
|
default:
|
|
throw new Error(`Invalid format: ${format}`);
|
|
}
|
|
});
|