Set checkProperties default value to false for prevent-abbreviations (#404)

Author: fisker

docs/rules/prevent-abbreviations.md

@@ -19,16 +19,6 @@ const e = new Error();
 const e = document.createEvent('Event');
 ```
 
-```js
-const levels = {
-	err: 0
-};
-```
-
-```js
-this.evt = 'click';
-```
-
 ```js
 class Btn {}
 ```
@@ -58,6 +48,18 @@ this.event = 'click';
 class Button {}
 ```
 
+```js
+// Property is not checked by default
+const levels = {
+	err: 0
+};
+```
+
+```js
+// Property is not checked by default
+this.evt = 'click';
+```
+
 
 ## Options
 
@@ -210,9 +212,9 @@ function f({err}) {}
 ### checkProperties
 
 Type: `boolean`<br>
-Default: `true`
+Default: `false`
 
-Pass `"checkProperties": false` to disable checking property names.
+Pass `"checkProperties": true` to enable checking property names.
 
 ### checkVariables
 

rules/prevent-abbreviations.js

@@ -194,7 +194,7 @@ const defaultWhitelist = {
 };
 
 const prepareOptions = ({
-	checkProperties = true,
+	checkProperties = false,
 	checkVariables = true,
 
 	checkDefaultAndNamespaceImports = false,

test/prevent-abbreviations.js

@@ -57,7 +57,7 @@ const extendedOptions = [{
 }];
 
 const customOptions = [{
-	checkProperties: false,
+	checkProperties: true,
 
 	checkDefaultAndNamespaceImports: true,
 	checkShorthandImports: true,
@@ -94,6 +94,10 @@ const dontCheckVariablesOptions = [{
 	checkVariables: false
 }];
 
+const checkPropertiesOptions = [{
+	checkProperties: true
+}];
+
 ruleTester.run('prevent-abbreviations', rule, {
 	valid: [
 		'let x',
@@ -137,6 +141,46 @@ ruleTester.run('prevent-abbreviations', rule, {
 		'let isJPEG',
 		'let NODE_ENV',
 
+		// Property should not report by default
+		'({err: 1})',
+		'({e: 1})',
+		'this.e = 1',
+		'({e() {}})',
+		'(class {e() {}})',
+		'this.eResDir = 1',
+		'this.err = 1',
+		'({err() {}})',
+		'(class {err() {}})',
+		'this.errCbOptsObj = 1',
+		'this.successCb = 1',
+		'this.btnColor = 1',
+		'({evt: 1})',
+		'foo.evt = 1',
+		outdent`
+			const foo = {
+				err() {}
+			};
+		`,
+		'foo.err = 1',
+		'foo.bar.err = 1',
+		'this.err = 1',
+		outdent`
+			class C {
+				err() {}
+			}
+		`,
+		'this._err = 1',
+		'this.__err__ = 1',
+		'this.e_ = 1',
+		'({Err: 1})',
+		'({Res: 1})',
+		'Foo.customProps = {}',
+		outdent`
+			class Foo {
+				static getDerivedContextFromProps() {}
+			}
+		`,
+
 		// Accessing banned names is allowed (as in `camelcase` rule)
 		'foo.err',
 		'foo.err()',
@@ -169,11 +213,6 @@ ruleTester.run('prevent-abbreviations', rule, {
 			options: extendedOptions
 		},
 
-		{
-			code: '({err: 1})',
-			options: customOptions
-		},
-
 		{
 			code: 'let err',
 			options: dontCheckVariablesOptions
@@ -210,22 +249,27 @@ ruleTester.run('prevent-abbreviations', rule, {
 		}),
 		noFixingTestCase({
 			code: '({e: 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e`. Suggested names are: `error`, `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.e = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e`. Suggested names are: `error`, `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '({e() {}})',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e`. Suggested names are: `error`, `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '(class {e() {}})',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e`. Suggested names are: `error`, `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.eResDir = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `eResDir`. Suggested names are: `errorResponseDirection`, `errorResponseDirectory`, `errorResultDirection`, ... (5 more omitted). A more descriptive name will do too.')
 		}),
 
@@ -241,22 +285,27 @@ ruleTester.run('prevent-abbreviations', rule, {
 		},
 		noFixingTestCase({
 			code: '({err: 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `err` should be named `error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.err = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `err` should be named `error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '({err() {}})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `err` should be named `error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '(class {err() {}})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `err` should be named `error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.errCbOptsObj = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `errCbOptsObj` should be named `errorCallbackOptionsObject`. A more descriptive name will do too.')
 		}),
 
@@ -273,10 +322,12 @@ ruleTester.run('prevent-abbreviations', rule, {
 
 		noFixingTestCase({
 			code: 'this.successCb = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 		noFixingTestCase({
 			code: 'this.btnColor = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 
@@ -292,10 +343,12 @@ ruleTester.run('prevent-abbreviations', rule, {
 		},
 		noFixingTestCase({
 			code: '({evt: 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `evt` should be named `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'foo.evt = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `evt` should be named `event`. A more descriptive name will do too.')
 		}),
 
@@ -367,11 +420,7 @@ ruleTester.run('prevent-abbreviations', rule, {
 
 		noFixingTestCase({
 			code: '({err: 1})',
-			errors: createErrors()
-		}),
-		noFixingTestCase({
-			code: '({err: 1})',
-			options: extendedOptions,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 
@@ -436,12 +485,6 @@ ruleTester.run('prevent-abbreviations', rule, {
 			errors: createErrors()
 		},
 
-		noFixingTestCase({
-			code: '({err: 1})',
-			options: dontCheckVariablesOptions,
-			errors: createErrors()
-		}),
-
 		noFixingTestCase({
 			code: outdent`
 				let e;
@@ -606,6 +649,7 @@ ruleTester.run('prevent-abbreviations', rule, {
 
 		noFixingTestCase({
 			code: 'const foo = {err: 1}',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 		noFixingTestCase({
@@ -614,18 +658,22 @@ ruleTester.run('prevent-abbreviations', rule, {
 					err() {}
 				};
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 		noFixingTestCase({
 			code: 'foo.err = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 		noFixingTestCase({
 			code: 'foo.bar.err = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 		noFixingTestCase({
 			code: 'this.err = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 
@@ -635,19 +683,23 @@ ruleTester.run('prevent-abbreviations', rule, {
 					err() {}
 				}
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		}),
 
 		noFixingTestCase({
 			code: 'this._err = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `_err` should be named `_error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.__err__ = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `__err__` should be named `__error__`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: 'this.e_ = 1',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e_`. Suggested names are: `error_`, `event_`. A more descriptive name will do too.')
 		}),
 
@@ -692,10 +744,12 @@ ruleTester.run('prevent-abbreviations', rule, {
 		},
 		noFixingTestCase({
 			code: '({Err: 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `Err` should be named `Error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '({Res: 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `Res`. Suggested names are: `Response`, `Result`. A more descriptive name will do too.')
 		}),
 
@@ -1015,6 +1069,12 @@ moduleRuleTester.run('prevent-abbreviations', rule, {
 	valid: [
 		'import {err as foo} from "foo"',
 
+		// Property should not report by default
+		outdent`
+			let foo;
+			export {foo as err};
+		`,
+
 		// Default import names are allowed
 		'import err from "err"',
 		'import err, {foo as bar} from "err"',
@@ -1177,6 +1237,7 @@ moduleRuleTester.run('prevent-abbreviations', rule, {
 				let foo;
 				export {foo as err};
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		})
 	]
@@ -1191,12 +1252,27 @@ babelRuleTester.run('prevent-abbreviations', rule, {
 				static propTypes = {};
 				static getDerivedStateFromProps() {}
 			}
+		`,
+
+		// Property should not report by default
+		outdent`
+			class Foo {
+				static propTypesAndStuff = {};
+			}
+		`,
+		'(class {e = 1})',
+		'(class {err = 1})',
+		outdent`
+			class C {
+				err = () => {}
+			}
 		`
 	],
 
 	invalid: [
 		{
 			code: 'Foo.customProps = {}',
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		},
 		{
@@ -1205,6 +1281,7 @@ babelRuleTester.run('prevent-abbreviations', rule, {
 					static propTypesAndStuff = {};
 				}
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		},
 		{
@@ -1213,15 +1290,18 @@ babelRuleTester.run('prevent-abbreviations', rule, {
 					static getDerivedContextFromProps() {}
 				}
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		},
 
 		noFixingTestCase({
 			code: '(class {e = 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('Please rename the property `e`. Suggested names are: `error`, `event`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
 			code: '(class {err = 1})',
+			options: checkPropertiesOptions,
 			errors: createErrors('The property `err` should be named `error`. A more descriptive name will do too.')
 		}),
 		noFixingTestCase({
@@ -1230,6 +1310,7 @@ babelRuleTester.run('prevent-abbreviations', rule, {
 					err = () => {}
 				}
 			`,
+			options: checkPropertiesOptions,
 			errors: createErrors()
 		})
 	]