doc: support 'removed' field in doc YAML sections

PR-URL: #22100 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
nodejs · Sep 6, 2018 · 060a62f · 060a62f
1 parent 2e0652d
commit 060a62f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/tools/doc/common.js b/tools/doc/common.js
@@ -34,6 +34,10 @@ function extractAndParseYAML(text) {
     meta.deprecated = arrify(meta.deprecated);
   }
 
+  if (meta.removed) {
+    meta.removed = arrify(meta.removed);
+  }
+
   meta.changes = meta.changes || [];
 
   return meta;

diff --git a/tools/doc/html.js b/tools/doc/html.js
@@ -264,6 +264,7 @@ function parseYAML(text) {
 
   const added = { description: '' };
   const deprecated = { description: '' };
+  const removed = { description: '' };
 
   if (meta.added) {
     added.version = meta.added.join(', ');
@@ -276,9 +277,15 @@ function parseYAML(text) {
         `<span>Deprecated since: ${deprecated.version}</span>`;
   }
 
+  if (meta.removed) {
+    removed.version = meta.removed.join(', ');
+    removed.description = `<span>Removed in: ${removed.version}</span>`;
+  }
+
   if (meta.changes.length > 0) {
     if (added.description) meta.changes.push(added);
     if (deprecated.description) meta.changes.push(deprecated);
+    if (removed.description) meta.changes.push(removed);
 
     meta.changes.sort((a, b) => versionSort(a.version, b.version));
 
@@ -299,7 +306,8 @@ function parseYAML(text) {
 
     result += '</table>\n</details>\n';
   } else {
-    result += `${added.description}${deprecated.description}\n`;
+    result += `${added.description}${deprecated.description}` +
+              `${removed.description}\n`;
   }
 
   if (meta.napiVersion) {