remix-project/remix-lib/src/astWalker.js

'use strict'
/**
 * Crawl the given AST through the function walk(ast, callback)
 */
function AstWalker () {
}

/**
 * visit all the AST nodes
 *
 * @param {Object} ast  - AST node
 * @param {Object or Function} callback  - if (Function) the function will be called for every node.
 *                                       - if (Object) callback[<Node Type>] will be called for
 *                                         every node of type <Node Type>. callback["*"] will be called fo all other nodes.
 *                                         in each case, if the callback returns false it does not descend into children.
 *                                         If no callback for the current type, children are visited.
 */
AstWalker.prototype.walk = function (ast, callback) {
  if (callback instanceof Function) {
    callback = {'*': callback}
  }
  if (!('*' in callback)) {
    callback['*'] = function () { return true }
  }
  if (manageCallBack(ast, callback) && ast.children && ast.children.length > 0) {
    for (var k in ast.children) {
      var child = ast.children[k]
      this.walk(child, callback)
    }
  }
}

/**
 * walk the given @astList
 *
 * @param {Object} sourcesList - sources list (containing root AST node)
 * @param {Function} - callback used by AstWalker to compute response
 */
AstWalker.prototype.walkAstList = function (sourcesList, callback) {
  var walker = new AstWalker()
  for (var k in sourcesList) {
    walker.walk(sourcesList[k].legacyAST, callback)
  }
}

function manageCallBack (node, callback) {
  if (node.name in callback) {
    return callback[node.name](node)
  } else {
    return callback['*'](node)
  }
}

module.exports = AstWalker