node/tools/doc/common.js
Vse Mozhet Byt 50e5eff12a tools: fix nits in tools/doc/common.js
PR-URL: https://github.com/nodejs/node/pull/19599
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-03-25 21:48:57 +03:00

38 lines
835 B
JavaScript

'use strict';
const yaml = require('js-yaml');
function isYAMLBlock(text) {
return /^<!-- YAML/.test(text);
}
function arrify(value) {
return Array.isArray(value) ? value : [value];
}
function extractAndParseYAML(text) {
text = text.trim()
.replace(/^<!-- YAML/, '')
.replace(/-->$/, '');
// js-yaml.safeLoad() throws on error
const meta = yaml.safeLoad(text);
if (meta.added) {
// Since semver-minors can trickle down to previous major versions,
// features may have been added in multiple versions.
meta.added = arrify(meta.added);
}
if (meta.deprecated) {
// Treat deprecated like added for consistency.
meta.deprecated = arrify(meta.deprecated);
}
meta.changes = meta.changes || [];
return meta;
}
module.exports = { isYAMLBlock, extractAndParseYAML };