Add URL to rule documentation to the metadata

ESLinvt v4.15.0 added an official location for rules to store a URL to their documentation in the rule metadata in eslint/eslint#9788. This adds the URL to all the existing rules so anything consuming them can know where their documentation is without having to resort to external packages to guess.
Arcanemagus · Jan 8, 2018 · aa5d03b · aa5d03b
1 parent a093afe
commit aa5d03b
Show file tree

Hide file tree

Showing 59 changed files with 177 additions and 0 deletions.
diff --git a/rules/angularelement.js b/rules/angularelement.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/angularelement.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/avoid-scope-typos.js b/rules/avoid-scope-typos.js
@@ -17,6 +17,9 @@ const scope = ['scope', '$scope', '$rootScope'];
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/avoid-scope-typos.md'
+        },
         schema: [ ]
     },
     create: function(context) {

diff --git a/rules/component-limit.js b/rules/component-limit.js
@@ -20,6 +20,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/component-limit.md'
+        },
         schema: [{
             type: 'integer'
         }]

diff --git a/rules/component-name.js b/rules/component-name.js
@@ -15,6 +15,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/component-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }]

diff --git a/rules/constant-name.js b/rules/constant-name.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/constant-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }, {

diff --git a/rules/controller-as-route.js b/rules/controller-as-route.js
@@ -14,6 +14,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/controller-as-route.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/controller-as-vm.js b/rules/controller-as-vm.js
@@ -20,6 +20,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/controller-as-vm.md'
+        },
         schema: [{
             type: 'string'
         }, {

diff --git a/rules/controller-as.js b/rules/controller-as.js
@@ -16,6 +16,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/controller-as.md'
+        },
         schema: [{
             type: ['object', 'string']
         }]

diff --git a/rules/controller-name.js b/rules/controller-name.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/controller-name.md'
+        },
         schema: [
             {
                 type: 'string'

diff --git a/rules/deferred.js b/rules/deferred.js
@@ -13,6 +13,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/deferred.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/definedundefined.js b/rules/definedundefined.js
@@ -18,6 +18,9 @@ const SHOULD_NOT_USE_BANG_WITH_ISUNDEFINED = 'Instead of !angular.isUndefined, y
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/definedundefined.md'
+        },
         schema: [],
         fixable: 'code'
     },

diff --git a/rules/di-order.js b/rules/di-order.js
@@ -16,6 +16,9 @@ var caseSensitive = 'case_sensitive';
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/di-order.md'
+        },
         schema: [{
             type: 'boolean'
         }, {

diff --git a/rules/di-unused.js b/rules/di-unused.js
@@ -14,6 +14,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/di-unused.md'
+        },
         schema: []
     },
     create: angularRule(function(context) {

diff --git a/rules/di.js b/rules/di.js
@@ -16,6 +16,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/di.md'
+        },
         schema: [{
             enum: [
                 'function',

diff --git a/rules/directive-name.js b/rules/directive-name.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/directive-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }]

diff --git a/rules/directive-restrict.js b/rules/directive-restrict.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/directive-restrict.md'
+        },
         schema: [{
             type: 'object',
             properties: {

diff --git a/rules/document-service.js b/rules/document-service.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/document-service.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/dumb-inject.js b/rules/dumb-inject.js
@@ -15,6 +15,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/dumb-inject.md'
+        },
         schema: []
     },
     create: angularRule(function(context) {

diff --git a/rules/empty-controller.js b/rules/empty-controller.js
@@ -14,6 +14,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/empty-controller.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/factory-name.js b/rules/factory-name.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/factory-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }, {

diff --git a/rules/file-name.js b/rules/file-name.js
@@ -57,6 +57,9 @@ function handleModuleCase(node, context, defaultFilename) {
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/file-name.md'
+        },
         schema: [{
             type: ['object']
         }]

diff --git a/rules/filter-name.js b/rules/filter-name.js
@@ -15,6 +15,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/filter-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }]

diff --git a/rules/foreach.js b/rules/foreach.js
@@ -11,6 +11,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/foreach.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/function-type.js b/rules/function-type.js
@@ -17,6 +17,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/function-type.md'
+        },
         schema: [{
             enum: [
                 'named',

diff --git a/rules/interval-service.js b/rules/interval-service.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/interval-service.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/json-functions.js b/rules/json-functions.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/json-functions.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/log.js b/rules/log.js
@@ -10,6 +10,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/log.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/module-dependency-order.js b/rules/module-dependency-order.js
@@ -19,6 +19,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/module-dependency-order.md'
+        },
         schema: [{
             type: 'object',
             properties: {

diff --git a/rules/module-getter.js b/rules/module-getter.js
@@ -15,6 +15,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/module-getter.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/module-name.js b/rules/module-name.js
@@ -16,6 +16,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/module-name.md'
+        },
         schema: [{
             type: ['string', 'object']
         }]

diff --git a/rules/module-setter.js b/rules/module-setter.js
@@ -15,6 +15,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/module-setter.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-angular-mock.js b/rules/no-angular-mock.js
@@ -32,6 +32,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-angular-mock.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-controller.js b/rules/no-controller.js
@@ -13,6 +13,9 @@ var utils = require('./utils/utils');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-controller.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-cookiestore.js b/rules/no-cookiestore.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-cookiestore.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-directive-replace.js b/rules/no-directive-replace.js
@@ -16,6 +16,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-directive-replace.md'
+        },
         schema: [{
             type: 'object',
             properties: {

diff --git a/rules/no-http-callback.js b/rules/no-http-callback.js
@@ -12,6 +12,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-http-callback.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-inline-template.js b/rules/no-inline-template.js
@@ -13,6 +13,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-inline-template.md'
+        },
         schema: [{
             allowSimple: {
                 type: 'boolean'

diff --git a/rules/no-jquery-angularelement.js b/rules/no-jquery-angularelement.js
@@ -10,6 +10,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-jquery-angularelement.md'
+        },
         schema: []
     },
     create: function(context) {

diff --git a/rules/no-private-call.js b/rules/no-private-call.js
@@ -13,6 +13,9 @@
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-private-call.md'
+        },
         schema: [
             {
                 type: 'object',

diff --git a/rules/no-run-logic.js b/rules/no-run-logic.js
@@ -15,6 +15,9 @@ var angularRule = require('./utils/angular-rule');
 
 module.exports = {
     meta: {
+        docs: {
+            url: 'https://github.com/Gillespie59/eslint-plugin-angular/blob/master/docs/rules/no-run-logic.md'
+        },
         schema: [{
             type: 'object',
             properties: {