From fbaab1d556ccf835132970898cc0c91260f7de38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Wed, 21 Mar 2018 15:31:11 +0100 Subject: [PATCH 1/2] tools: make metadata parsing less permissive --- tools/doc/common.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/doc/common.js b/tools/doc/common.js index ce4995ddff39d1..9f7a25ecd484a3 100644 --- a/tools/doc/common.js +++ b/tools/doc/common.js @@ -21,14 +21,14 @@ function extractAndParseYAML(text) { // js-yaml.safeLoad() throws on error const meta = yaml.safeLoad(text); - const added = meta.added || meta.Added; + const 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; + const deprecated = meta.deprecated; if (deprecated) { // Treat deprecated like added for consistency. meta.deprecated = arrify(deprecated); From f83fbd1740dedb9d2d100ca97b1cc89c9c6960f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Wed, 21 Mar 2018 15:37:12 +0100 Subject: [PATCH 2/2] tools: shorten metadata parsing --- tools/doc/common.js | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/tools/doc/common.js b/tools/doc/common.js index 9f7a25ecd484a3..3a66cbd7b05065 100644 --- a/tools/doc/common.js +++ b/tools/doc/common.js @@ -13,31 +13,28 @@ function arrify(value) { } function extractAndParseYAML(text) { - text = text.trim(); - - text = text.replace(/^$/, ''); // js-yaml.safeLoad() throws on error const meta = yaml.safeLoad(text); - const added = meta.added; - if (added) { + if (meta.added) { // Since semver-minors can trickle down to previous major versions, // features may have been added in multiple versions. - meta.added = arrify(added); + meta.added = arrify(meta.added); } - const deprecated = meta.deprecated; - if (deprecated) { + if (meta.deprecated) { // Treat deprecated like added for consistency. - meta.deprecated = arrify(deprecated); + meta.deprecated = arrify(meta.deprecated); } meta.changes = meta.changes || []; - meta.changes.forEach((entry) => { + for (const entry of meta.changes) { entry.description = entry.description.replace(/^\^\s*/, ''); - }); + } return meta; }