New config: recommended just includes variable-pattern rule

Part of #249

Author: edg2s

README.md

@@ -34,9 +34,13 @@ Add `no-jquery` to the plugins section of your `.eslintrc` configuration file. Y
 }
 ```
 
-The config `plugin:no-jquery/deprecated` includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for jQuery 3.5.x+ environments (`deprecated-3.5`), and configs for other minor releases that include deprecations (`deprecated-3.4`, `deprecated-1.10` etc.). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+## 📋 Configs
 
-The config `plugin:no-jquery/all` includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
+The config **`plugin:no-jquery/recommended`** includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
+
+The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for jQuery 3.5.x+ environments (`deprecated-3.5`), and configs for other minor releases that include deprecations (`deprecated-3.4`, `deprecated-1.10` etc.). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+
+The config **`plugin:no-jquery/all`** includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
 
 Alternatively, you can pick out rules individually (see below).
 
@@ -166,7 +170,7 @@ Where rules are included in the configs `slim`, `all` or `deprecated-X.X` it is
 * [`no-jquery/no-visibility`](docs/rules/no-visibility.md) `all`
 * [`no-jquery/no-when`](docs/rules/no-when.md) `all`
 * [`no-jquery/no-wrap`](docs/rules/no-wrap.md) `all`
-* [`no-jquery/variable-pattern`](docs/rules/variable-pattern.md)
+* [`no-jquery/variable-pattern`](docs/rules/variable-pattern.md) `recommended`
 
 ### ⚠️ Deprecated
 

README.md.template

@@ -33,9 +33,13 @@ Add `no-jquery` to the plugins section of your `.eslintrc` configuration file. Y
 }
 ```
 
-The config `plugin:no-jquery/deprecated` includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for jQuery 3.5.x+ environments (`deprecated-3.5`), and configs for other minor releases that include deprecations (`deprecated-3.4`, `deprecated-1.10` etc.). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+## 📋 Configs
 
-The config `plugin:no-jquery/all` includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
+The config **`plugin:no-jquery/recommended`** includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
+
+The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for jQuery 3.5.x+ environments (`deprecated-3.5`), and configs for other minor releases that include deprecations (`deprecated-3.4`, `deprecated-1.10` etc.). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+
+The config **`plugin:no-jquery/all`** includes all methods and utilies and should be used when you are aiming to remove all jQuery usage from your code.
 
 Alternatively, you can pick out rules individually (see below).
 

docs/rules/variable-pattern.md

@@ -2,6 +2,8 @@
 
 Disallows variable names which don't match `variablePattern` in settings (by default a `$`-prefix).
 
+⚙️ This rule is enabled in `plugin:no-jquery/recommended`.
+
 ## Rule details
 
 ❌ Examples of **incorrect** code:

src/index.js

@@ -101,6 +101,11 @@ module.exports = {
 		'variable-pattern': require( './rules/variable-pattern' )
 	},
 	configs: {
+		recommended: {
+			rules: {
+				'no-jquery/variable-pattern': 'error'
+			}
+		},
 		// Use this config if you are using jQuery slim build
 		slim: {
 			rules: {

test-self/.eslintrc.json

@@ -6,7 +6,10 @@
 		"$": "readonly"
 	},
 	"rules": {
+		"no-implicit-globals": "off",
 		"no-undef": "off",
-		"no-unused-expressions": "off"
+		"no-underscore-dangle": "off",
+		"no-unused-expressions": "off",
+		"no-unused-vars": "off"
 	}
 }

test-self/all/.eslintrc.json

@@ -1,6 +1,3 @@
 {
-	"extends": "plugin:self/all",
-	"rules": {
-		"no-underscore-dangle": "off"
-	}
+	"extends": "plugin:self/all"
 }

test-self/recommended/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+	"extends": "plugin:self/recommended"
+}

test-self/recommended/test.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line self/variable-pattern
+var foo = $( '.foo' );