Merge pull request #350 from Gillespie59/1.0

1.0

Author: remcohaszing

.eslintrc renamed to .eslintrc.yaml

@@ -32,6 +32,7 @@ rules:
  no-sparse-arrays: 2
  no-unreachable: 1
  use-isnan: 2
+
  valid-jsdoc: 0
  valid-typeof: 2
 
@@ -160,6 +161,13 @@ rules:
  - 2
  - 4
  - SwitchCase: 1
+
+ # http://eslint.org/docs/rules/keyword-spacing.html
+ keyword-spacing:
+ - 2
+ - before: true
+ after: true
+ overrides: {}
  key-spacing:
  - 2
  - beforeColon: false
@@ -217,9 +225,6 @@ rules:
  sort-vars:
  - 2
  - ignoreCase: true
- space-after-keywords:
- - 2
- - always
  space-before-blocks:
  - 2
  - always
@@ -230,7 +235,6 @@ rules:
  - 2
  - never
  space-infix-ops: 2
- space-return-throw-case: 2
  space-unary-ops:
  - 2
  - words: true

README.md

@@ -90,72 +90,6 @@ Users may use the shareable [eslint-config-angular](https://github.com/dustinspe
  ```
 
 
-
-## Defaults
-
-```json
-{
- "plugins": [
- "angular/angular"
- ],
- "rules": {
- "angular/angularelement": 1,
- "angular/component-limit": [0, 1],
- "angular/controller-as": 2,
- "angular/controller-as-route": 2,
- "angular/controller-as-vm": [2, "vm"],
- "angular/controller-name": [2, "/[A-Z].*Controller$/"],
- "angular/deferred": 0,
- "angular/definedundefined": 2,
- "angular/di": [2, "function"],
- "angular/di-order": 0,
- "angular/di-unused": 0,
- "angular/directive-name": 0,
- "angular/directive-restrict": 0,
- "angular/document-service": 2,
- "angular/dumb-inject": 0,
- "angular/empty-controller": 0,
- "angular/file-name": 0,
- "angular/filter-name": 0,
- "angular/foreach": 0,
- "angular/function-type": 0,
- "angular/interval-service": 2,
- "angular/json-functions": 2,
- "angular/log": 2,
- "angular/module-dependency-order": [0, {"grouped": false, "prefix": null}],
- "angular/module-getter": 2,
- "angular/module-name": 0,
- "angular/module-setter": 2,
- "angular/no-angular-mock": 0,
- "angular/no-controller": 0,
- "angular/no-cookiestore": 2,
- "angular/no-digest": 0,
- "angular/no-directive-replace": 0,
- "angular/no-http-callback": 0,
- "angular/no-inline-template": [0, {"allowSimple": true}],
- "angular/no-jquery-angularelement": 2,
- "angular/no-private-call": 2,
- "angular/no-run-logic": 0,
- "angular/no-services": [2, ["$http", "$resource", "Restangular", "$q"]],
- "angular/no-service-method": 2,
- "angular/on-watch": 2,
- "angular/one-dependency-per-line": 0,
- "angular/rest-service": 0,
- "angular/service-name": 0,
- "angular/timeout-service": 2,
- "angular/typecheck-array": 2,
- "angular/typecheck-date": 2,
- "angular/typecheck-function": 2,
- "angular/typecheck-number": 2,
- "angular/typecheck-object": 2,
- "angular/typecheck-regexp": 2,
- "angular/typecheck-string": 2,
- "angular/watchers-execution": [0, "$digest"],
- "angular/window-service": 2
- }
-}
-```
-
 ----
 
 
@@ -164,22 +98,22 @@ Users may use the shareable [eslint-config-angular](https://github.com/dustinspe
 Rules in eslint-plugin-angular are divided into several categories to help you better understand their value.
 
 
-## Possible Errors
+### Possible Errors
 
 The following rules detect patterns that can lead to errors.
 
  * [module-getter](docs/module-getter.md) - disallow to reference modules with variables and require to use the getter syntax instead `angular.module('myModule')` ([y022](https://github.com/johnpapa/angular-styleguide#style-y022))
  * [module-setter](docs/module-setter.md) - disallow to assign modules to variables (linked to [module-getter](docs/module-getter.md) ([y021](https://github.com/johnpapa/angular-styleguide#style-y021))
  * [no-private-call](docs/no-private-call.md) - disallow use of internal angular properties prefixed with $$
 
-## Best Practices
+### Best Practices
 
 These are rules designed to prevent you from making mistakes. They either prescribe a better way of doing something or help you avoid footguns..
 
  * [component-limit](docs/component-limit.md) - limit the number of angular components per file ([y001](https://github.com/johnpapa/angular-styleguide#style-y001))
- * [controller-as](docs/controller-as.md) - disallow assignments to `$scope` in controllers ([y031](https://github.com/johnpapa/angular-styleguide#style-y031))
  * [controller-as-route](docs/controller-as-route.md) - require the use of controllerAs in routes or states ([y031](https://github.com/johnpapa/angular-styleguide#style-y031))
  * [controller-as-vm](docs/controller-as-vm.md) - require and specify a capture variable for `this` in controllers ([y032](https://github.com/johnpapa/angular-styleguide#style-y032))
+ * [controller-as](docs/controller-as.md) - disallow assignments to `$scope` in controllers ([y031](https://github.com/johnpapa/angular-styleguide#style-y031))
  * [deferred](docs/deferred.md) - use `$q(function(resolve, reject){})` instead of `$q.deferred`
  * [di-unused](docs/di-unused.md) - disallow unused DI parameters
  * [directive-restrict](docs/directive-restrict.md) - disallow any other directive restrict than 'A' or 'E' ([y074](https://github.com/johnpapa/angular-styleguide#style-y074))
@@ -190,15 +124,15 @@ These are rules designed to prevent you from making mistakes. They either prescr
  * [no-services](docs/no-services.md) - disallow DI of specified services for other angular components (`$http` for controllers, filters and directives)
  * [on-watch](docs/on-watch.md) - require `$on` and `$watch` deregistration callbacks to be saved in a variable
 
-## Deprecated Angular Features
+### Deprecated Angular Features
 
 These rules prevent you from using deprecated angular features.
 
  * [no-cookiestore](docs/no-cookiestore.md) - use `$cookies` instead of `$cookieStore`
  * [no-directive-replace](docs/no-directive-replace.md) - disallow the deprecated directive replace property
  * [no-http-callback](docs/no-http-callback.md) - disallow the `$http` methods `success()` and `error()`
 
-## Naming
+### Naming
 
 These rules help you to specify several naming conventions.
 
@@ -209,12 +143,12 @@ These rules help you to specify several naming conventions.
  * [module-name](docs/module-name.md) - require and specify a prefix for all module names ([y127](https://github.com/johnpapa/angular-styleguide#style-y127))
  * [service-name](docs/service-name.md) - require and specify a prefix for all service names ([y125](https://github.com/johnpapa/angular-styleguide#style-y125))
 
-## Conventions
+### Conventions
 
 Angular often provide multi ways to to something. These rules help you to define convention for your project.
 
- * [di](docs/di.md) - require a consistent DI syntax
  * [di-order](docs/di-order.md) - require DI parameters to be sorted alphabetically
+ * [di](docs/di.md) - require a consistent DI syntax
  * [dumb-inject](docs/dumb-inject.md) - unittest `inject` functions should only consist of assignments from injected values to describe block variables
  * [function-type](docs/function-type.md) - require and specify a consistent function style for components ('named' or 'anonymous') ([y024](https://github.com/johnpapa/angular-styleguide#style-y024))
  * [module-dependency-order](docs/module-dependency-order.md) - require a consistent order of module dependencies
@@ -223,7 +157,7 @@ Angular often provide multi ways to to something. These rules help you to define
  * [rest-service](docs/rest-service.md) - disallow different rest service and specify one of '$http', '$resource', 'Restangular'
  * [watchers-execution](docs/watchers-execution.md) - require and specify consistent use `$scope.digest()` or `$scope.apply()`
 
-## Angular Wrappers
+### Angular Wrappers
 
 These rules help you to enforce the usage of angular wrappers.
 
@@ -245,12 +179,18 @@ These rules help you to enforce the usage of angular wrappers.
  * [typecheck-string](docs/typecheck-string.md) - use `angular.isString` instead of `typeof` comparisons
  * [window-service](docs/window-service.md) - use `$window` instead of `window` ([y180](https://github.com/johnpapa/angular-styleguide#style-y180))
 
-## Deprecated rules
 
-These rules will be removed in version 1.0.0
 
- * [no-digest](docs/no-digest.md) - use `$apply()` instead of `$digest()` (replaced by [watchers-execution](docs/watchers-execution.md))
- * [typecheck-regexp](docs/typecheck-regexp.md) - use `angular.isRegexp` instead of other comparisons (no native angular method)
+## Environments
+
+This plugin enables the use of environments targeted at AngularJS. These environments define the globals each situation respectively.
+
+```yaml
+env:
+ angular/angular: true
+ angular/mocks: true
+ angular/protractor: true
+```
 
 
 ----
@@ -357,12 +297,10 @@ return {
 
 Here is the basic configuration for the rules defined in the ESLint plugin, in order to be compatible with the guideline provided by @johnpapa :
 
-```json
-{
- "rules": {
- "no-use-before-define": 0
- }
-}
+```yaml
+rules:
+ no-use-before-define:
+ - 0
 ```
 
 

docs/component-limit.md

@@ -5,6 +5,8 @@
 The number of AngularJS components in one file should be limited.
 The default limit is one.
 
+- The acceptable number of components. (Default: 1)
+
 **Styleguide Reference**
 
 * [y001 by johnpapa - Define 1 component per file](https://github.com/johnpapa/angular-styleguide#style-y001)

docs/controller-as-route.md

@@ -19,6 +19,12 @@ The following patterns are considered problems;
   controller: 'MyController'
  }) // error: Route "/myroute" should use controllerAs syntax
 
+ // invalid
+ $routeProvider.when('/myroute', {
+  controller: 'MyController as vm',
+  controllerAs: 'vm'
+ }) // error: The controllerAs syntax is defined twice for the route "/myroute"
+
 The following patterns are **not** considered problems;
 
  /*eslint angular/controller-as-route: 2*/
@@ -29,6 +35,11 @@ The following patterns are **not** considered problems;
   controllerAs: 'vm'
  });
 
+ // valid
+ $routeProvider.when('/myroute', {
+  controller: 'MyController as vm'
+ });
+
 ## Version
 
 This rule was introduced in eslint-plugin-angular 0.1.0

docs/controller-as-vm.md

@@ -6,6 +6,8 @@ You should use a capture variable for 'this' when using the controllerAs syntax.
 The second parameter specifies the capture variable you want to use in your application.
 The third parameter can be a Regexp for identifying controller functions (when using something like Browserify)
 
+- The name that should be used for the view model.
+
 **Styleguide Reference**
 
 * [y032 by johnpapa - controllerAs with vm](https://github.com/johnpapa/angular-styleguide#style-y032)

docs/module-dependency-order.md

@@ -24,7 +24,7 @@ The following patterns are **not** considered problems with default config;
  /*eslint angular/module-dependency-order: 2*/
 
  // valid
- angular.module('myModule', ['app', 'appFilters', 'ngAnimate', 'ngRoute', 'ui.router']);
+ angular.module('myModule', ['ngAnimate', 'ngRoute', 'app', 'appFilters', 'ui.router']);
 
 The following patterns are considered problems when configured `{"grouped":true}`:
 

docs/no-digest.md

@@ -0,0 +1,28 @@
+'use strict';
+
+module.exports = {
+ angular: {
+ globals: {
+ angular: true
+ }
+ },
+ // https://docs.angularjs.org/api/ngMock
+ mocks: {
+ globals: {
+ angular: true,
+ inject: true,
+ module: true
+ }
+ },
+ // http://www.protractortest.org/#/api
+ protractor: {
+ globals: {
+ element: true,
+ $: true,
+ $$: true,
+ browser: true,
+ by: true,
+ protractor: true
+ }
+ }
+};

docs/typecheck-regexp.md

@@ -4,8 +4,18 @@ $routeProvider.when('/myroute', {
  controllerAs: 'vm'
 });
 
+// example - valid: true
+$routeProvider.when('/myroute', {
+ controller: 'MyController as vm'
+});
+
 // example - valid: false, errorMessage: "Route \"/myroute\" should use controllerAs syntax"
 $routeProvider.when('/myroute', {
  controller: 'MyController'
 })
 
+// example - valid: false, errorMessage: "The controllerAs syntax is defined twice for the route \"/myroute\""
+$routeProvider.when('/myroute', {
+ controller: 'MyController as vm',
+ controllerAs: 'vm'
+})