Add support for tracking a function's scope level

kgryte · kgryte · commit 19b89ae85658 · 2017-12-06T04:25:20.000-08:00
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/lib/analyze.js b/lib/node_modules/@stdlib/_tools/js/program-summary/lib/analyze.js
@@ -26,10 +26,11 @@ var type2key = require( './type2key.js' );
 * @param {Node} ast - AST node
 * @param {string} src - source code
 * @param {StringArray} lines - source code lines
+* @param {NonNegativeInteger} level - recursion level
 * @param {Options} opts - parse options
 * @returns {Object} results
 */
-function analyze( results, ast, src, lines, opts ) {
+function analyze( results, ast, src, lines, level, opts ) {
 	var nodes;
 	var node;
 	var type;
@@ -45,7 +46,8 @@ function analyze( results, ast, src, lines, opts ) {
 	results.lines += ast.loc.end.line - ast.loc.start.line + 1;
 
 	// Flatten the AST:
-	nodes = flatten( ( ast.type !== 'Program' && ast.body ) ? ast.body : ast );
+	node = ( ast.type !== 'Program' && ast.body ) ? ast.body : ast;
+	nodes = flatten( node, level );
 
 	// Calculate the number of source lines of codes (SLOC):
 	results.sloc += sloc( nodes );
@@ -59,6 +61,9 @@ function analyze( results, ast, src, lines, opts ) {
 	// Tabulate AST node occurrences:
 	results = tabulate( results, nodes );
 
+	// Increment the recursion level:
+	level += 1;
+
 	// Recursively analyze AST nodes:
 	for ( i = 0; i < nodes.length; i++ ) {
 		node = nodes[ i ];
@@ -82,13 +87,14 @@ function analyze( results, ast, src, lines, opts ) {
 
 			// Analyze the AST:
 			key = type2key( type );
-			res = analyze( res, ast, str, lines, opts );
+			res = analyze( res, ast, str, lines, level, opts );
 
 			// Include results specific to particular AST nodes:
 			if ( type === 'SwitchStatement' ) {
 				res.case = node.cases.length;
 			} else if ( type === 'FunctionDeclaration' ) {
 				res.params = node.params.length;
+				res.level = node.__scope_level__; // eslint-disable-line no-underscore-dangle
 			}
 			// Cache the sub-tree results:
 			results[ key ].data.push( res );
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/lib/flatten.js b/lib/node_modules/@stdlib/_tools/js/program-summary/lib/flatten.js
@@ -14,9 +14,10 @@ var types = require( './node_types.js' );
 *
 * @private
 * @param {Node} ast - AST node
+* @param {NonNegativeInteger} level - recursion level
 * @returns {Array} flattened AST
 */
-function flatten( ast ) {
+function flatten( ast, level ) {
 	var out = [];
 	walk( ast, visit );
 	return out;
@@ -29,8 +30,18 @@ function flatten( ast ) {
 	* @param {*} state - state
 	* @param {Array<Node>} ancestors - ancestor nodes
 	*/
-	function visit( node ) {
+	function visit( node, state, ancestors ) {
+		var i;
 		if ( node !== ast && contains( types, node.type ) ) {
+			// For functions, track the function scope (i.e., level of function nesting):
+			if ( node.type === 'FunctionDeclaration' ) {
+				node.__scope_level__ = level; // eslint-disable-line no-underscore-dangle
+				for ( i = 0; i < ancestors.length-1; i++ ) {
+					if ( ancestors[ i ].type === 'FunctionDeclaration' ) {
+						node.__scope_level__ += 1; // eslint-disable-line no-underscore-dangle
+					}
+				}
+			}
 			out.push( node );
 		}
 	} // end FUNCTION visit()
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/lib/main.js b/lib/node_modules/@stdlib/_tools/js/program-summary/lib/main.js
@@ -52,7 +52,7 @@ function summary( input ) {
 	ast = parse( input, opts );
 
 	// Analyze the AST:
-	results = analyze( results, ast, input, lines, opts );
+	results = analyze( results, ast, input, lines, 0, opts );
 
 	// Return the summary results:
 	return results;
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/1.json b/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/1.json
@@ -1213,7 +1213,8 @@
           "count": 0,
           "data": []
         },
-        "params": 2
+        "params": 2,
+        "level": 0
       }
     ]
   }
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/2.json b/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/2.json
@@ -935,7 +935,8 @@
           "count": 0,
           "data": []
         },
-        "params": 2
+        "params": 2,
+        "level": 0
       }
     ]
   }
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/empty_function_declaration.json b/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/empty_function_declaration.json
@@ -129,7 +129,8 @@
           "count": 0,
           "data": []
         },
-        "params": 0
+        "params": 0,
+        "level": 0
       }
     ]
   }
diff --git a/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/function_declaration.json b/lib/node_modules/@stdlib/_tools/js/program-summary/test/fixtures/function_declaration.json
@@ -129,7 +129,8 @@
           "count": 0,
           "data": []
         },
-        "params": 2
+        "params": 2,
+        "level": 0
       }
     ]
   }

Original file line number	Diff line number	Diff line change
`@@ -1213,7 +1213,8 @@`
`1213`	`1213`	`"count": 0,`
`1214`	`1214`	`"data": []`
`1215`	`1215`	`},`
`1216`		`- "params": 2`
	`1216`	`+ "params": 2,`
	`1217`	`+ "level": 0`
`1217`	`1218`	`}`
`1218`	`1219`	`]`
`1219`	`1220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -935,7 +935,8 @@`
`935`	`935`	`"count": 0,`
`936`	`936`	`"data": []`
`937`	`937`	`},`
`938`		`- "params": 2`
	`938`	`+ "params": 2,`
	`939`	`+ "level": 0`
`939`	`940`	`}`
`940`	`941`	`]`
`941`	`942`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,8 @@`
`129`	`129`	`"count": 0,`
`130`	`130`	`"data": []`
`131`	`131`	`},`
`132`		`- "params": 0`
	`132`	`+ "params": 0,`
	`133`	`+ "level": 0`
`133`	`134`	`}`
`134`	`135`	`]`
`135`	`136`	`}`