angular-hint-modules

Angular Hint: Modules

Angular Hint Modules lets you spend less time finding silent errors in your code and more time programming. This tool is a subset of many under the Angular Hint repository that specializes in identifying errors relating to directives. For instructions on how to incorporate the whole Angular Hint repository into your project, please refer to the link above.

Angular Hint Modules identifies:

• Modules missing proper namespaces
• Modules created but never loaded
• Multiple modules created with same name
• Undeclared modules loaded
• Using ngView without ngRoute

Missing Namespace

It is important for modules we create to have their own unique namespace so as to not conflict with existing modules in Angular or external libraries that may be used. As in the example below, if a module with name 'breadcrumb' was created, you would be warned and prompted to use a more appropriate name that adheres to namespace best practices.

angular.module('breadcrumbs').
  directive('myComponent', function() { ... };
});

Creating and Loading Modules

Hint Modules also notifies you of common problems regarding the creation and loading of modules.

The following code snippit will be the example for the following sections:

angular.module('createdAndLoaded',[]);
angular.module('createdAndLoaded',[]);
angular.module('createdButNotLoaded',[]);
angular.module('testModule',
  ['ngHintModules','createdAndLoaded', 'createdButNLoadd','iDontEvenexist']);

In the example above you would be warned that:

• The createdButNotLoaded module was created but that it was never loaded into the application.
• The createdButNLoadd module was not found and that you should try createdButNotLoaded.
• The createdAndLoaded module name was used twice and the first will be overwritten.
• The iDontEvenexist module was loaded but it was never created.

ngView with ngRoute

After routing was seperated from Angular.js, it was required to have ngRoute as a dependency for your main module. Since this change, ngRoute often got left out, so this module also notifies you if you have routing in your application without requiring ngRoute.

License

Copyright 2014 Google, Inc. http://angularjs.org

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.