angular-dependency

Information


##Usage
In order to retrieve the angular dependency tree a function is directly
available on the package, here is an example:

``javascript
var angularDependency = require('angular-dependency');

//return an AngularModules object
var angularModules = angularDependency('/path/to/scan');

`

##AngularModules
This object contains all angular references needed to build a dependency tree:

`javascript
//retrieve the dependency tree of the module1, can throw a CircularDependency
var dependencyTree = angularModules.resolve('module1');

//retrieve a flat representation of the dependencies of module1
var flat = true;
var dependencyTree = angularModules.resolve('module1', flat);
`

Sometimes, you do not want to retrieve some modules because you already know
where they belongs, or because they are present by default.
You can specify this in the resolve last argument which is a string or array
of modules to exclude

`javascript

var exclude = 'ngResource'; // can also be ['ngResource', 'someOtherModule']
var dependencyTree = angularModules.resolve('module1', exclude);

// you can still specify if you want a flat representation
var flat = true;
var dependencyTree = angularModules.resolve('module1', flat, exclude);
`

##AngularModulesFactory

This object is provided by the lib file, all errors are also publicly available
in this module.

usage:
`javascript
var angularModulesFactory = new AngularModulesFactory();


var path = 'file/path';
var content = fs.readdirSync(path).toString();

/*
* Process file in order to extract angular modules definition, can throw
* an AlreadyDefined exception if a module with the same name is defined
* multiple times
*/
angularModulesFactory.processFile(content, path);


/*
* Retrieves the AngularModules object from the factory, can throw a NotDefined
* exception if a module is has not been initialized in the angular files.
*/
var angularModules = angularModulesFactory.getModules();

``

LICENSE

(MIT License)

Copyright (c) 2014 Maxime Vidori

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.