docs: create separate rule docs

Author: bmish

.eslintrc.js

@@ -10,4 +10,14 @@ module.exports = {
     es2017: true,
     node: true,
   },
+  rules: {
+    'eslint-plugin/require-meta-docs-description': 'error',
+    'eslint-plugin/require-meta-docs-url': [
+      'error',
+      {
+        pattern:
+          'https://github.com/emberjs/eslint-plugin-ember-internal/tree/master/docs/rules/{{name}}.md',
+      },
+    ],
+  },
 };

README.md

@@ -42,36 +42,12 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
-## Supported Rules
-
-- `require-yuidoc-access` - Ensures that every YUIDoc comment has `@public`, `@protected` or `@private` declared
-- `no-const-outside-module-scope` - Prevent `const` from being used outside of the module scope (e.g. in functions)
-- `no-empty-yuidoc-code-blocks` - Prevents empty code blocks in YUIDoc comments, e.g.
-
-    ```js
-    /**
-     * See code below:
-     *
-     * ```js
-     * ```
-     */
-    ```
-
-- `require-yuidoc-code-block-type` - Ensures that every code blocks in YUIDoc comments has a type associated, e.g.
-
-    ```js
-    /**
-     * See code below:
-     *
-     * ```js
-     * good
-     * ```
-     *
-     * ```
-     * bad
-     * ```
-     */
-    ```
+## Rules
+
+- [`no-const-outside-module-scope`](./docs/rules/no-const-outside-module-scope.md)
+- [`no-empty-yuidoc-code-blocks`](./docs/rules/no-empty-yuidoc-code-blocks.md)
+- [`require-yuidoc-access`](./docs/rules/require-yuidoc-access.md)
+- [`require-yuidoc-code-block-type`](./docs/rules/require-yuidoc-code-block-type.md)
 
 ## License
 

docs/rules/no-const-outside-module-scope.md

@@ -0,0 +1,3 @@
+# no-const-outside-module-scope
+
+Prevent `const` from being used outside of the module scope (e.g. in functions).

docs/rules/no-empty-yuidoc-code-blocks.md

@@ -0,0 +1,12 @@
+# no-empty-yuidoc-code-blocks
+
+Prevents empty code blocks in YUIDoc comments, e.g.
+
+```js
+/**
+ * See code below:
+ *
+ * ```js
+ * ```
+ */
+```

docs/rules/require-yuidoc-access.md

@@ -0,0 +1,3 @@
+# require-yuidoc-access
+
+Ensures that every YUIDoc comment has `@public`, `@protected` or `@private` declared.

docs/rules/require-yuidoc-code-block-type.md

@@ -0,0 +1,17 @@
+# require-yuidoc-code-block-type
+
+Ensures that every code blocks in YUIDoc comments has a type associated.
+
+```js
+/**
+ * See code below:
+ *
+ * ```js
+ * good
+ * ```
+ *
+ * ```
+ * bad
+ * ```
+ */
+```

lib/rules/no-const-outside-module-scope.js

@@ -6,6 +6,11 @@ module.exports = {
     type: 'suggestion',
     fixable: 'code',
     schema: [],
+    docs: {
+      description:
+        'disallow `const` from being used outside of the module scope (e.g. in functions)',
+      url: 'https://github.com/emberjs/eslint-plugin-ember-internal/tree/master/docs/rules/no-const-outside-module-scope.md',
+    },
   },
   create(context) {
     return {

lib/rules/no-empty-yuidoc-code-blocks.js

@@ -13,6 +13,10 @@ module.exports = {
   meta: {
     type: 'suggestion',
     schema: [],
+    docs: {
+      description: 'disallow empty code blocks in YUIDoc comments',
+      url: 'https://github.com/emberjs/eslint-plugin-ember-internal/tree/master/docs/rules/no-empty-yuidoc-code-blocks.md',
+    },
   },
   create: function (context) {
     var sourceCode = context.getSourceCode();

lib/rules/require-yuidoc-access.js

@@ -17,6 +17,11 @@ module.exports = {
   meta: {
     type: 'suggestion',
     schema: [],
+    docs: {
+      description:
+        'require that every YUIDoc comment has `@public`, `@protected` or `@private` declared',
+      url: 'https://github.com/emberjs/eslint-plugin-ember-internal/tree/master/docs/rules/require-yuidoc-access.md',
+    },
   },
   create: function (context) {
     var sourceCode = context.getSourceCode();

lib/rules/require-yuidoc-code-block-type.js

@@ -26,6 +26,10 @@ module.exports = {
   meta: {
     type: 'suggestion',
     schema: [],
+    docs: {
+      description: 'require that every code blocks in YUIDoc comments has a type associated',
+      url: 'https://github.com/emberjs/eslint-plugin-ember-internal/tree/master/docs/rules/require-yuidoc-code-block-type.md',
+    },
   },
   create: function (context) {
     var sourceCode = context.getSourceCode();