Add URL to rule documentation to the metadata

ESLint 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.
jsx-eslint · Jan 8, 2018 · bf544dc · bf544dc
1 parent c23d395
commit bf544dc
Show file tree

Hide file tree

Showing 71 changed files with 244 additions and 72 deletions.
diff --git a/lib/rules/boolean-prop-naming.js b/lib/rules/boolean-prop-naming.js
@@ -7,6 +7,7 @@
 const has = require('has');
 const Components = require('../util/Components');
 const propsUtil = require('../util/props');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -17,7 +18,8 @@ module.exports = {
     docs: {
       category: 'Stylistic Issues',
       description: 'Enforces consistent naming for boolean props',
-      recommended: false
+      recommended: false,
+      url: docsUrl('boolean-prop-naming')
     },
 
     schema: [{

diff --git a/lib/rules/button-has-type.js b/lib/rules/button-has-type.js
@@ -6,6 +6,7 @@
 
 const getProp = require('jsx-ast-utils/getProp');
 const getLiteralPropValue = require('jsx-ast-utils/getLiteralPropValue');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Helpers
@@ -27,7 +28,8 @@ module.exports = {
     docs: {
       description: 'Forbid "button" element without an explicit "type" attribute',
       category: 'Possible Errors',
-      recommended: false
+      recommended: false,
+      url: docsUrl('button-has-type')
     },
     schema: [{
       type: 'object',

diff --git a/lib/rules/default-props-match-prop-types.js b/lib/rules/default-props-match-prop-types.js
@@ -11,6 +11,7 @@ const variableUtil = require('../util/variable');
 const annotations = require('../util/annotations');
 const astUtil = require('../util/ast');
 const propsUtil = require('../util/props');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -20,7 +21,8 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce all defaultProps are defined and not "required" in propTypes.',
-      category: 'Best Practices'
+      category: 'Best Practices',
+      url: docsUrl('default-props-match-prop-types')
     },
 
     schema: [{

diff --git a/lib/rules/destructuring-assignment.js b/lib/rules/destructuring-assignment.js
@@ -4,6 +4,7 @@
 'use strict';
 
 const Components = require('../util/Components');
+const docsUrl = require('../util/docsUrl');
 
 const DEFAULT_OPTION = 'always';
 
@@ -12,7 +13,8 @@ module.exports = {
     docs: {
       description: 'Enforce consistent usage of destructuring assignment of props, state, and context',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('destructuring-assignment')
     },
     schema: [{
       type: 'string',

diff --git a/lib/rules/display-name.js b/lib/rules/display-name.js
@@ -6,6 +6,7 @@
 
 const has = require('has');
 const Components = require('../util/Components');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -16,7 +17,8 @@ module.exports = {
     docs: {
       description: 'Prevent missing displayName in a React component definition',
       category: 'Best Practices',
-      recommended: true
+      recommended: true,
+      url: docsUrl('display-name')
     },
 
     schema: [{

diff --git a/lib/rules/forbid-component-props.js b/lib/rules/forbid-component-props.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Constants
 // ------------------------------------------------------------------------------
@@ -19,7 +21,8 @@ module.exports = {
     docs: {
       description: 'Forbid certain props on components',
       category: 'Best Practices',
-      recommended: false
+      recommended: false,
+      url: docsUrl('forbid-component-props')
     },
 
     schema: [{

diff --git a/lib/rules/forbid-dom-props.js b/lib/rules/forbid-dom-props.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Constants
 // ------------------------------------------------------------------------------
@@ -19,7 +21,8 @@ module.exports = {
     docs: {
       description: 'Forbid certain props on DOM Nodes',
       category: 'Best Practices',
-      recommended: false
+      recommended: false,
+      url: docsUrl('forbid-dom-props')
     },
 
     schema: [{

diff --git a/lib/rules/forbid-elements.js b/lib/rules/forbid-elements.js
@@ -5,6 +5,7 @@
 'use strict';
 
 const has = require('has');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -15,7 +16,8 @@ module.exports = {
     docs: {
       description: 'Forbid certain elements',
       category: 'Best Practices',
-      recommended: false
+      recommended: false,
+      url: docsUrl('forbid-elements')
     },
 
     schema: [{

diff --git a/lib/rules/forbid-foreign-prop-types.js b/lib/rules/forbid-foreign-prop-types.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Constants
 // ------------------------------------------------------------------------------
@@ -18,7 +20,8 @@ module.exports = {
     docs: {
       description: 'Forbid using another component\'s propTypes',
       category: 'Best Practices',
-      recommended: false
+      recommended: false,
+      url: docsUrl('forbid-foreign-prop-types')
     }
   },
 

diff --git a/lib/rules/forbid-prop-types.js b/lib/rules/forbid-prop-types.js
@@ -6,6 +6,7 @@
 const variableUtil = require('../util/variable');
 const propsUtil = require('../util/props');
 const astUtil = require('../util/ast');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Constants
@@ -22,7 +23,8 @@ module.exports = {
     docs: {
       description: 'Forbid certain propTypes',
       category: 'Best Practices',
-      recommended: false
+      recommended: false,
+      url: docsUrl('forbid-prop-types')
     },
 
     schema: [{

diff --git a/lib/rules/jsx-boolean-value.js b/lib/rules/jsx-boolean-value.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Rule Definition
 // ------------------------------------------------------------------------------
@@ -48,7 +50,8 @@ module.exports = {
     docs: {
       description: 'Enforce boolean attributes notation in JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-boolean-value')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-closing-bracket-location.js b/lib/rules/jsx-closing-bracket-location.js
@@ -5,6 +5,7 @@
 'use strict';
 
 const has = require('has');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -14,7 +15,8 @@ module.exports = {
     docs: {
       description: 'Validate closing bracket location in JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-closing-bracket-location')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-closing-tag-location.js b/lib/rules/jsx-closing-tag-location.js
@@ -5,6 +5,7 @@
 'use strict';
 
 const astUtil = require('../util/ast');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -14,7 +15,8 @@ module.exports = {
     docs: {
       description: 'Validate closing tag location for multiline JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-closing-tag-location')
     },
     fixable: 'whitespace'
   },

diff --git a/lib/rules/jsx-curly-brace-presence.js b/lib/rules/jsx-curly-brace-presence.js
@@ -5,6 +5,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Constants
 // ------------------------------------------------------------------------------
@@ -31,7 +33,8 @@ module.exports = {
         'Disallow unnecessary JSX expressions when literals alone are sufficient ' +
           'or enfore JSX expressions on literals in JSX children or attributes',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-curly-brace-presence')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-curly-spacing.js b/lib/rules/jsx-curly-spacing.js
@@ -11,6 +11,7 @@
 'use strict';
 
 const has = require('has');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -27,7 +28,8 @@ module.exports = {
     docs: {
       description: 'Enforce or disallow spaces inside of curly braces in JSX attributes',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-curly-spacing')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-equals-spacing.js b/lib/rules/jsx-equals-spacing.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Rule Definition
 // ------------------------------------------------------------------------------
@@ -13,7 +15,8 @@ module.exports = {
     docs: {
       description: 'Disallow or enforce spaces around equal signs in JSX attributes',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-equals-spacing')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-filename-extension.js b/lib/rules/jsx-filename-extension.js
@@ -5,6 +5,7 @@
 'use strict';
 
 const path = require('path');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Constants
@@ -23,7 +24,8 @@ module.exports = {
     docs: {
       description: 'Restrict file extensions that may contain JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-filename-extension')
     },
 
     schema: [{

diff --git a/lib/rules/jsx-first-prop-new-line.js b/lib/rules/jsx-first-prop-new-line.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Rule Definition
 // ------------------------------------------------------------------------------
@@ -13,7 +15,8 @@ module.exports = {
     docs: {
       description: 'Ensure proper position of the first property in JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-first-prop-new-line')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-handler-names.js b/lib/rules/jsx-handler-names.js
@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const docsUrl = require('../util/docsUrl');
+
 // ------------------------------------------------------------------------------
 // Rule Definition
 // ------------------------------------------------------------------------------
@@ -13,7 +15,8 @@ module.exports = {
     docs: {
       description: 'Enforce event handler naming conventions in JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-handler-names')
     },
 
     schema: [{

diff --git a/lib/rules/jsx-indent-props.js b/lib/rules/jsx-indent-props.js
@@ -30,6 +30,7 @@
 'use strict';
 
 const astUtil = require('../util/ast');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -39,7 +40,8 @@ module.exports = {
     docs: {
       description: 'Validate props indentation in JSX',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-indent-props')
     },
     fixable: 'code',
 

diff --git a/lib/rules/jsx-indent.js b/lib/rules/jsx-indent.js
@@ -30,6 +30,7 @@
 'use strict';
 
 const astUtil = require('../util/ast');
+const docsUrl = require('../util/docsUrl');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -39,7 +40,8 @@ module.exports = {
     docs: {
       description: 'Validate JSX indentation',
       category: 'Stylistic Issues',
-      recommended: false
+      recommended: false,
+      url: docsUrl('jsx-indent')
     },
     fixable: 'whitespace',
     schema: [{