docs: automate docs with eslint-doc-generator (#61)

Author: bmish

.eslintrc.js

@@ -17,6 +17,9 @@ module.exports = {
     env: {
         mocha: true,
     },
+    rules: {
+        "eslint-plugin/require-meta-docs-description": "error",
+    },
     overrides: [
         {
             // these messageIds were used outside

README.md

@@ -1,5 +1,6 @@
-# n/callback-return
-> require `return` statements after callbacks
+# Require `return` statements after callbacks (`n/callback-return`)
+
+<!-- end auto-generated rule header -->
 
 The callback pattern is at the heart of most I/O and event-driven programming
  in JavaScript.

docs/rules/callback-return.md

@@ -1,6 +1,8 @@
-# n/exports-style
-> enforce either `module.exports` or `exports`
-> - ✒️ The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+# Enforce either `module.exports` or `exports` (`n/exports-style`)
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 `module.exports` and `exports` are the same instance by default.
 But those come to be different if one of them is modified.

docs/rules/exports-style.md

@@ -1,6 +1,8 @@
-# n/file-extension-in-import
-> enforce the style of file extensions in `import` declarations
-> - ✒️ The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+# Enforce the style of file extensions in `import` declarations (`n/file-extension-in-import`)
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 We can omit file extensions in `import`/`export` declarations.
 

docs/rules/file-extension-in-import.md

@@ -1,5 +1,6 @@
-# n/global-require
-> require `require()` calls to be placed at top-level module scope
+# Require `require()` calls to be placed at top-level module scope (`n/global-require`)
+
+<!-- end auto-generated rule header -->
 
 In Node.js, module dependencies are included using the `require()` function, such as:
 

docs/rules/global-require.md

@@ -1,5 +1,6 @@
-# n/handle-callback-err
-> require error handling in callbacks
+# Require error handling in callbacks (`n/handle-callback-err`)
+
+<!-- end auto-generated rule header -->
 
 In Node.js, a common pattern for dealing with asynchronous behavior is called the callback pattern.
 This pattern expects an `Error` object or `null` as the first argument of the callback.

docs/rules/handle-callback-err.md

@@ -1,5 +1,6 @@
-# n/no-callback-literal
-> ensure Node.js-style error-first callback pattern is followed
+# Enforce Node.js-style error-first callback pattern is followed (`n/no-callback-literal`)
+
+<!-- end auto-generated rule header -->
 
 When invoking a callback function which uses the Node.js error-first callback pattern, all of your errors should either use the `Error` class or a subclass of it. It is also acceptable to use `undefined` or `null` if there is no error.
 
@@ -28,16 +29,6 @@ callback(new Error('some error'));
 callback(someVariable);
 ```
 
-### Options
-
-```json
-{
-    "rules": {
-        "n/no-callback-literal": "error"
-    }
-}
-```
-
 ## 🔎 Implementation
 
 - [Rule source](../../lib/rules/no-callback-literal.js)

docs/rules/no-callback-literal.md

@@ -1,6 +1,8 @@
-# n/no-exports-assign
-> disallow the assignment to `exports`
-> - ⭐️ This rule is included in `plugin:n/recommended` preset.
+# Disallow the assignment to `exports` (`n/no-exports-assign`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommended-module`, ✔️ `recommended-script`.
+
+<!-- end auto-generated rule header -->
 
 To assign to `exports` variable would not work as expected.