doc: highlight deprecated API in ToC

Highlight deprecated API methods/properties in "Table of Contents" for increasing understandability. Adapted code to eslint standards. PR-URL: #7189Fixes: nodejs/nodejs.org#772 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>

Author: ilfroloff

doc/api_assets/style.css

@@ -330,6 +330,21 @@ hr{
 margin-top:.666em;
 }
 
+#toc .stability_0::after{
+background-color:#d50027;
+color:#fff;
+}
+
+#toc .stability_0::after{
+content:"deprecated";
+font-size:.8em;
+position: relative;
+top:-.18em;
+left:.5em;
+padding:0.3em.2em;
+border-radius:3px;
+}
+
 #apicontentli{
 margin-bottom:.5em;
 }

tools/doc/html.js

@@ -9,6 +9,8 @@ const typeParser = require('./type-parser.js');
 
 module.exports=toHTML;
 
+constSTABILITY_TEXT_REG_EXP=/(.*:)\s*(\d)([\s\S]*)/;
+
 // customized heading without id attribute
 varrenderer=newmarked.Renderer();
 renderer.heading=function(text,level){
@@ -153,8 +155,11 @@ function parseLists(input){
 varsavedState=[];
 vardepth=0;
 varoutput=[];
+letheadingIndex=-1;
+letheading=null;
+
 output.links=input.links;
-input.forEach(function(tok){
+input.forEach(function(tok,index){
 if(tok.type==='blockquote_start'){
 savedState.push(state);
 state='MAYBE_STABILITY_BQ';
@@ -167,6 +172,17 @@ function parseLists(input){
 if((tok.type==='paragraph'&&state==='MAYBE_STABILITY_BQ')||
 tok.type==='code'){
 if(tok.text.match(/Stability:.*/g)){
+conststabilityMatch=tok.text.match(STABILITY_TEXT_REG_EXP);
+conststability=Number(stabilityMatch[2]);
+constisStabilityIndex=
+index-2===headingIndex||// general
+index-3===headingIndex;// with api_metadata block
+
+if(heading&&isStabilityIndex){
+heading.stability=stability;
+headingIndex=-1;
+heading=null;
+}
 tok.text=parseAPIHeader(tok.text);
 output.push({type: 'html',text: tok.text});
 return;
@@ -178,6 +194,8 @@ function parseLists(input){
 if(state===null||
 (state==='AFTERHEADING'&&tok.type==='heading')){
 if(tok.type==='heading'){
+headingIndex=index;
+heading=tok;
 state='AFTERHEADING';
 }
 output.push(tok);
@@ -280,7 +298,7 @@ function linkJsTypeDocs(text){
 
 functionparseAPIHeader(text){
 text=text.replace(
-/(.*:)\s(\d)([\s\S]*)/,
+STABILITY_TEXT_REG_EXP,
 '<pre class="api_stability api_stability_$2">$1 $2$3</pre>'
 );
 returntext;
@@ -324,8 +342,8 @@ function buildToc(lexed, filename, cb){
 constrealFilename=path.basename(realFilenames[0],'.md');
 constid=getId(realFilename+'_'+tok.text.trim());
 toc.push(newArray((depth-1)*2+1).join(' ')+
-'* <a href="#'+id+'">'+
-tok.text+'</a>');
+'* <span class="stability_'+tok.stability+'">'+
+'<a href="#'+id+'">'+tok.text+'</a></span>');
 tok.text+='<span><a class="mark" href="#'+id+'" '+
 'id="'+id+'">#</a></span>';
 });