fix: remove disallowed description property from config (#476)

platinumazure · Feb 12, 2024 · 28804af · 28804af
1 parent 05bbdcd
commit 28804af
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -13,14 +13,10 @@ 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).
 
-<!-- begin auto-generated configs list -->
-
-|    | Name          | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| :- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| | 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. For ESLint `.eslintrc.js` legacy config, extend from `"plugin:qunit/recommended"`. For ESLint `eslint.config.js` flat config, load from `require('eslint-plugin-qunit/configs/recommended')`. |
 
-<!-- end auto-generated configs list -->
-
 ## Rules
 
 <!-- begin auto-generated rules list -->

diff --git a/index.js b/index.js
@@ -21,11 +21,6 @@ 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.",
-                'For ESLint `.eslintrc.js` legacy config, extend from `"plugin:qunit/recommended"`.',
-                "For ESLint `eslint.config.js` flat config, load from `require('eslint-plugin-qunit/configs/recommended')`.",
-            ].join(" "),
             plugins: ["qunit"],
             rules: {
                 "qunit/assert-args": "error",