docs: auto-generate configs list and some rule options lists with esl…

…int-doc-generator (#416)
platinumazure · Oct 14, 2023 · 6fa0bdd · 6fa0bdd
1 parent 257ba14
commit 6fa0bdd
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -13,9 +13,13 @@ You can extend from a configuration in order to simplify manual configuration of
 
 For more details on how to extend your configuration from a plugin configuration, please see the [ESLint plugin configuration documentation](https://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin).
 
-|     | Name | Description |
-| :-- | :--- | :---------- |
-| ✅ | recommended | This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. You can use this configuration by extending from `"plugin:qunit/recommended"` in your configuration file. |
+<!-- begin auto-generated configs list -->
+
+|    | Name          | Description                                                                                                                                                                                                                                                                                                                                        |
+| :- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ✅  | `recommended` | This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. You can use this configuration by extending from `"plugin:qunit/recommended"` in your configuration file. |
+
+<!-- end auto-generated configs list -->
 
 ## Rules
 

diff --git a/docs/rules/no-ok-equality.md b/docs/rules/no-ok-equality.md
@@ -66,9 +66,13 @@ QUnit.test("Name", function (assert) { assert.ok(x instanceof Number); });
 
 ## Options
 
-This rule takes an optional object containing:
+<!-- begin auto-generated rule options list -->
 
-* `allowGlobals` (boolean, default: true): Whether the rule should check global assertions
+| Name          | Description                                      | Type    | Default |
+| :------------ | :----------------------------------------------- | :------ | :------ |
+| `allowGlobal` | Whether the rule should check global assertions. | Boolean | `true`  |
+
+<!-- end auto-generated rule options list -->
 
 ## When Not to Use It
 

diff --git a/index.js b/index.js
@@ -15,6 +15,7 @@ module.exports = {
     // eslint-disable-next-line sort-keys
     configs: {
         recommended: {
+            description: "This configuration includes rules which I recommend to avoid QUnit runtime errors or incorrect behavior, some of which can be difficult to debug. Some of these rules also encourage best practices that help QUnit work better for you. You can use this configuration by extending from `\"plugin:qunit/recommended\"` in your configuration file.",
             plugins: ["qunit"],
             rules: {
                 "qunit/assert-args": "error",

diff --git a/lib/rules/no-ok-equality.js b/lib/rules/no-ok-equality.js
@@ -28,7 +28,9 @@ module.exports = {
                 type: "object",
                 properties: {
                     allowGlobal: {
-                        type: "boolean"
+                        type: "boolean",
+                        description: "Whether the rule should check global assertions.",
+                        default: true
                     }
                 },
                 additionalProperties: false

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -32,7 +32,7 @@
     "chai": "^4.3.10",
     "coveralls": "^3.1.1",
     "eslint": "^8.51.0",
-    "eslint-doc-generator": "^1.4.3",
+    "eslint-doc-generator": "^1.5.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.1.1",
     "eslint-plugin-markdown": "^3.0.1",