docs

Author: Jesse Zhang

README.md

@@ -51,22 +51,23 @@ Dependency Tree Building:
 Additional Files:
 * **requiredLibs** (Array<sup>1</sup> | String | RegExp): Files included but *not* parsed for dependencies. Use this in conjunction with *parseExclude*.
 * **optionalLibs** (Array<sup>1</sup> | String | RegExp): Optional library files that, if depended on, will also include all files matched by the *optionalLibsInclude*.
-* **optionalLibsInclude** (String): Glob of files relative to the optional library file to be included if the optional library file is depended on.
+* **optionalLibsInclude** (Array<sup>1</sup> | String | RegExp): Optional library files to include if matching optional library defined by *optionalLib* is included
 
 Modules and Dependencies:
 * **appModule** (String): Name of main Angular module. This will be used to create an `init.js` file in the stream which will contain `angular.module(appModule, [all required modules]);`.
 * **globalModules** (Array | String): Modules to include in the `init.js` modules list that will not be found via the dependency tree building (e.g. modules in files from both *requiredLibs* and *parseExclude*).
 * **globalDependencies** (Array | String): Dependencies that will be defined globally but will not be found via the dependency tree building (e.g. dependencies from modules in *globalModules*). Unfound dependencies will throw a gulp error otherwise.
-* **filesWithResolvedDeps** (Array<sup>1</sup> | String | RegExp): Files that contain resolved dependencies (e.g. ui-bootstrap modal controllers).
 
 Misc:
-* **ignoredTemplates** (Array<sup>1</sup> | String | RegExp): Template strings to ignore looking for. 
 * **filePriority** (Array | String): Files sorted to the top of the stream.
 
 <sup>1</sup> Array of Strings or RegExps. Files are selected by partial matches.
 
 ---
 ## Notes
+#### Watch mode
+TODO
+
 #### Automatically Required Files
 TODO
 
@@ -77,17 +78,18 @@ TODO
 * Directives need to return an object, not a reference to an object
     * `return { templateUrl: "...", link: "..." };`
     * Not `var d = { templateUrl: "...", link: "..." }; return d;`
+* Resolved injections into controllers uses the "resolve" property for the object defining the resolve (see ui-router or ui-bootstrap modals)
 
 #### Misc:
 * All dependencies beginning with $ will be ignored.
 * Inline controllers within directives will be parsed if the controller function block is defined in the return object (i.e. not a reference to the controller).
 * Anything that matches the pattern `"controller": "SomeCtrl"` will consider `SomeCtrl` to be a dependency. (Quotes can be single or double; object key does not require quotes.)
 * All strings found in the file ending in *.html* or *.json* will be considered a template of that file (unless ignored via the *ignoredTemplates* option).
+* Supports $inject property
 
 ---
 ## Limitations
 * Dynamically built template URLs will not be included (in both html partials and js files)
-* No support (yet?) for $inject property
 
 ---
 ## Example
@@ -96,35 +98,31 @@ TODO
 ```
 module.exports = {
     seed: [
-        "./index.html.ejs",
-        
-        "./shared/app/app.js",
-        "./shared/app/routes.js",
-        
-        "./local/app/app.js",
-        "./local/app/routes.js"
+        "./index.html.ejs"
     ],
     options: {
         parseExclude: [
             "/libs/",
             /\/libs-optional\/[^\/]+\/includes\//i
         ],
         requiredFiles: [],
-        ignoredTemplates: [
-            /assets/
-        ],
         requiredLibs: [
             "/libs/"
         ],
         filePriority: [
-            "jquery.js",
-            "lodash.js",
-            "angular.js"
+            "/libs/jquery/jquery.js",
+            "/libs/lodash/lodash.js",
+            "/libs/angular/angular.js",
+            "/libs/jquery/",
+            "/libs/lodash/",
+            "/libs/angular/"
         ],
         optionalLibs: [
             "/libs-optional/"
         ],
-        optionalLibsInclude: "includes/*.js",
+        optionalLibsInclude: [
+            /\/libs-optional\/[^\/]+\/includes\/[^\/]+\.js/i
+        ],
         globalDependencies: [
             "Restangular"
         ],
@@ -135,9 +133,8 @@ module.exports = {
             "ui.bootstrap",
             "restangular"
         ],
-        filesWithResolvedDeps: [
-            /modal/i
-        ]
+        verbose: true,
+        debug: false
     }
 }
 ```

index.js

@@ -1,7 +1,8 @@
 var through = require("through2"),
 	gutil = require("gulp-util"),
 	Graph = require("./lib/Graph"),
-	filters = require("./consts/angular-filters");
+	filters = require("./consts/angular-filters"),
+	PluginError = require("./lib/errors").PluginError;
 
 module.exports = function (seeds, options) {
 	options = parseOptions(options);
@@ -73,10 +74,34 @@ module.exports.watch = function (seeds, options) {
 };
 
 function parseOptions(options) {
-	// TODO: add defaults
+	if (!options.appModule) {
+		throw new PluginError("Missing options.appModule in configuration.");
+	}
+
+	options.parseExclude = parseOption(options.parseExclude);
+	options.requiredFiles = parseOption(options.requiredFiles);
+	options.requiredLibs = parseOption(options.requiredLibs);
+	options.filePriority = parseOption(options.filePriority);
+	options.optionalLibs = parseOption(options.optionalLibs);
+	options.optionalLibsInclude = parseOption(options.optionalLibsInclude);
+	options.globalDependencies = parseOption(options.globalDependencies);
+	options.globalModules = parseOption(options.globalModules);
+
+	options.verbose = options.verbose || false;
+	options.debug = options.debug || false;
 
 	filters.forEach(function (filter) {
 		options.globalDependencies.push("filter:" + filter);
 	});
 	return options;
+}
+
+function parseOption(option) {
+	if (option instanceof Array) {
+		return option;
+	}
+	if (option == null) {
+		return [];
+	}
+	return [option];
 }

lib/MetaData.js

@@ -35,6 +35,7 @@ var MetaData = function (path) {
 	this.resolves = {};
 
 	this.type = {
+		app: false,
 		config: false,
 		run: false,
 		required: false
@@ -114,6 +115,10 @@ MetaData.prototype.addItem = function (type, item) {
 	}
 };
 
+MetaData.prototype.isApp = function () {
+	this.type.app = true;
+	this.isRequired();
+};
 MetaData.prototype.isConfig = function () {
 	this.type.config = true;
 	this.isRequired();
@@ -141,13 +146,21 @@ MetaData.prototype.merge = function (src) {
 		});
 	});
 
+	if (src.type.app) {
+		this.isApp();
+	}
+
 	if (src.type.config) {
 		this.isConfig();
 	}
 
 	if (src.type.run) {
 		this.isRun();
 	}
+
+	if (src.type.required) {
+		this.isRequired();
+	}
 };
 
 module.exports = MetaData;

lib/errors.js

@@ -39,4 +39,11 @@ module.exports.GraphError = function (reason, component, path) {
 		"\nComponent: " + component +
 		"\nReason: " + reason
 	);
+};
+
+module.exports.PluginError = function (reason) {
+	return new gutil.PluginError(
+		"gulp-angular-builder",
+		reason
+	);
 };

lib/parsers/html-parser.js

@@ -3,19 +3,13 @@ var htmlparser = require("htmlparser2"),
 
 module.exports = function (contents, metadata) {
 	metadata = metadata || new MetaData();
-
-	var parsed = parseContent(contents);
-	Object.keys(parsed).forEach(function (type) {
-		parsed[type].forEach(function (dep) {
-			metadata.addDependency(type, dep);
-		});
-	});
-
+	parseContent(contents, metadata);
 	return metadata;
 };
 
-function parseContent(contents) {
-	var component = [],
+function parseContent(contents, metadata) {
+	var isApp = false,
+		component = [],
 		template = [],
 		directiveToken = [],
 		animationToken = [],
@@ -48,7 +42,9 @@ function parseContent(contents) {
 			}
 
 			Object.keys(attributes).forEach(function (attr) {
-				if (attr == "ng-include") {
+				if (attr == "ng-app") {
+					isApp = true;
+				} else if (attr == "ng-include") {
 					// Add template
 					template.push(attributes[attr]);
 				} else if (attr == "ng-controller") {
@@ -88,11 +84,25 @@ function parseContent(contents) {
 		return _;
 	});
 
-	return {
-		component: component,
-		filter: filter,
-		template: template,
-		directiveToken: directiveToken,
-		animationToken: animationToken
-	};
+	component.forEach(function (dep) {
+		metadata.addDependency("component", dep);
+	});
+	filter.forEach(function (dep) {
+		metadata.addDependency("filter", dep);
+	});
+	template.forEach(function (dep) {
+		metadata.addDependency("template", dep);
+	});
+	directiveToken.forEach(function (dep) {
+		metadata.addDependency("directiveToken", dep);
+	});
+	animationToken.forEach(function (dep) {
+		metadata.addDependency("animationToken", dep);
+	});
+
+	if (isApp) {
+		metadata.isApp();
+	}
+
+	return metadata;
 }

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "gulp-angular-builder",
-	"version": "0.3.0-beta",
+	"version": "0.3.0",
 	"description": "Gulp plugin to filter and include only necessary AngularJS files.",
 	"main": "index.js",
 	"repository": {