eslint-plugin-angular/docs/controller-name.md

ESLint rules for AngularJS projects

<!-- WARNING: Generated documentation. Edit docs and examples in the rule and examples file ('rules/controller-name.js', 'examples/controller-name.js'). -->

# controller-name - require and specify a prefix for all controller names

All your controllers should have a name starting with the parameter you can define in your config object.
The second parameter can be a Regexp wrapped in quotes.
("controller-name":  [2, "ng"])

**Styleguide Reference**

* [y123 by johnpapa - Controller Names](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y123)
* [y124 by johnpapa - Controller Name Suffix](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y124)

## Examples

The following patterns are considered problems with default config;

    /*eslint angular/controller-name: 2*/

    // invalid
    angular.module('myModule').controller('MyCtrl', function () {
        // ...
    }); // error: The MyCtrl controller should follow this pattern: /[A-Z].*Controller$/

The following patterns are **not** considered problems with default config;

    /*eslint angular/controller-name: 2*/

    // valid
    angular.module('myModule').controller('MyController', function () {
       // ...
    });

The following patterns are considered problems when configured `"ui"`:

    /*eslint angular/controller-name: [2,"ui"]*/

    // invalid
    angular.module('myModule').controller('TabsController', function () {
        // ...
    }); // error: The TabsController controller should be prefixed by ui

The following patterns are **not** considered problems when configured `"ui"`:

    /*eslint angular/controller-name: [2,"ui"]*/

    // valid
    angular.module('myModule').controller('uiTabsController', function () {
        // ...
    });

The following patterns are considered problems when configured `"/[A-Z].*Ctrl/"`:

    /*eslint angular/controller-name: [2,"/[A-Z].*Ctrl/"]*/

    // invalid
    angular.module('myModule').controller('MyController', function () {
        // ...
    }); // error: The MyController controller should follow this pattern: /[A-Z].*Ctrl/

The following patterns are **not** considered problems when configured `"/[A-Z].*Ctrl/"`:

    /*eslint angular/controller-name: [2,"/[A-Z].*Ctrl/"]*/

    // valid
    angular.module('myModule').controller('MyCtrl', function () {
        // ...
    });

## Version

This rule was introduced in eslint-plugin-angular 0.1.0

## Links

* [Rule source](../rules/controller-name.js)
* [Example source](../examples/controller-name.js)