ng-ast

Builds abstract syntax tree from runtime AngularJs module: required modules, services, factories, etc

Install

bower install ng-ast
// include bower_components/ng-ast/ng-ast.js
// ngAst returns a promise
ngAst('Foo').then(function (root) { ... });
// builds tree starting with module Foo

Each node has name, dependencies, values, services, etc. (strings). A node also has children array pointing at required modules.

Example

basic usage

angular.module('foo', [])
    .value('a', 'value a')
    .service('b', function() {});
angular.module('bar', ['foo'])
    .constant('aConst', 4)
    .factory('aFactory', function() {});
var expected = {
  name: 'bar',
  dependencies: ['foo'],
  values: [],
  constants: ['aConst'],
  services: [],
  factories: ['aFactory'],
  children: [
    {
      name: 'foo',
      dependencies: [],
      values: ['a'],
      constants: [],
      services: ['b'],
      factories: [],
      children: []
    }
  ]
};
ngAst('bar').then(function (root) {
  isEqual(root, expected); // true
});

finds constants with short names

angular.module('foo', [])
    .constant('a', 'value a')
    .service('aService', function() {});
angular.module('bar', ['foo'])
    .constant('b', 4)
    .factory('aFactory', function() {});
function isValidName(name) {
  return name.length > 1;
}
function verifyConstants(node) {
  if (!node.constants.every(isValidName)) {
    throw new Error('module ' + node.name + ' has invalid constants ' + node.constants);
  }
  node.children.forEach(verifyConstants);
}
ngAst('bar').then(function (root) {
  function verifyBar() {
    verifyConstants(root);
  }
  check.raises(verifyBar); // true
  // exception has module name and constants
});

Validating names

I included a script to validate module / values / services / etc names.

// include bower_components/ng-ast/ng-ast.js
// include bower_components/ng-ast/ng-ast-validate-names.js
var options = {
  isValidModuleName: function (name) { return name.length < 10; }
  // available functions
  // isValidModuleName, isValidValueName, isValidConstantName, isValidServiceName
  // isValidFactoryName
}
validateAngularModuleNames('rootModuleName', options);
// throws exception if any name does not pass a check

Small print

Author: Gleb Bahmutov © 2014 @bahmutov glebbahmutov.com

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github