mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.0 KiB
45 lines
1.0 KiB
'use strict';
|
|
|
|
const yaml = require('js-yaml');
|
|
|
|
function isYAMLBlock(text) {
|
|
return !!text.match(/^<!-- YAML/);
|
|
}
|
|
|
|
exports.isYAMLBlock = isYAMLBlock;
|
|
|
|
function arrify(value) {
|
|
return Array.isArray(value) ? value : [value];
|
|
}
|
|
|
|
function extractAndParseYAML(text) {
|
|
text = text.trim();
|
|
|
|
text = text.replace(/^<!-- YAML/, '')
|
|
.replace(/-->$/, '');
|
|
|
|
// js-yaml.safeLoad() throws on error
|
|
const meta = yaml.safeLoad(text);
|
|
|
|
const added = meta.added || meta.Added;
|
|
if (added) {
|
|
// Since semver-minors can trickle down to previous major versions,
|
|
// features may have been added in multiple versions.
|
|
meta.added = arrify(added);
|
|
}
|
|
|
|
const deprecated = meta.deprecated || meta.Deprecated;
|
|
if (deprecated) {
|
|
// Treat deprecated like added for consistency.
|
|
meta.deprecated = arrify(deprecated);
|
|
}
|
|
|
|
meta.changes = meta.changes || [];
|
|
meta.changes.forEach((entry) => {
|
|
entry.description = entry.description.replace(/^\^\s*/, '');
|
|
});
|
|
|
|
return meta;
|
|
}
|
|
|
|
exports.extractAndParseYAML = extractAndParseYAML;
|
|
|