wip: fix message, remove obsolete variables, and add output to invalid examples

Author: kresimir-coko

projects/eslint-plugin/rules/general/lib/rules/blank-line-declaration-usage.js

@@ -3,15 +3,20 @@
  * SPDX-License-Identifier: MIT
  */
 
+const message =
+	'Expected an empty line between variable declaration and usage.';
+
 module.exports = {
 	create(context) {
 		const sourceCode = context.getSourceCode();
 
 		return {
 			VariableDeclaration(node) {
 				if (
+					node.parent.type === 'ForStatement' ||
+					node.parent.type === 'ForInStatement' ||
 					node.parent.type === 'ForOfStatement' ||
-					node.parent.type === 'ForStatement'
+					node.parent.type === 'WhileStatement'
 				) {
 					return;
 				}
@@ -30,18 +35,13 @@ module.exports = {
 					) {
 						context.report({
 							fix: (fixer) => {
-								const referenceStartLine =
-									reference.identifier.loc.start.line;
 								const declarationEndLine = node.loc.end.line;
 
-								if (
-									referenceStartLine ===
-									declarationEndLine + 1
-								) {
+								if (referenceLine === declarationEndLine + 1) {
 									return fixer.insertTextAfter(node, '\n');
 								}
 							},
-							message: 'error msg',
+							message,
 							node: reference.identifier,
 						});
 					}
@@ -53,7 +53,7 @@ module.exports = {
 	meta: {
 		docs: {
 			category: 'Best Practices',
-			description: 'error msg',
+			description: message,
 			recommended: false,
 			url: 'https://github.com/liferay/eslint-config-liferay/issues/139',
 		},

projects/eslint-plugin/rules/general/tests/lib/rules/blank-line-declaration-usage.js

@@ -12,6 +12,9 @@ const parserOptions = {
 	},
 };
 
+const message =
+	'Expected an empty line between variable declaration and usage.';
+
 const ruleTester = new MultiTester(parserOptions);
 
 ruleTester.run('blank-line-declaration-usage', rule, {
@@ -23,84 +26,135 @@ ruleTester.run('blank-line-declaration-usage', rule, {
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const test = 'test';
+
+				const testLength = test.length;
+			`,
 		},
 		{
 			code: `
 				const obj = {
 					foo: 'bar',
 					bar: 'foo',
-					hi: 'bryce',
+					life: 'ray',
 				}
-			  	Object.keys(obj)
+				Object.keys(obj)
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const obj = {
+					foo: 'bar',
+					bar: 'foo',
+					life: 'ray',
+				}
+
+				Object.keys(obj)
+			`,
 		},
 		{
 			code: `
 				function updateData() {
 					const obj = {
 						foo: 'bar',
 						bar: 'foo',
-						hi: 'bryce',
+						life: 'ray',
 					}
 
-					const formattedCategoryIds = Object.keys(obj).length
+					const ids = Object.keys(obj).length
 						? 'superLongStringSoThatItForcesTheLineToBeWrapped'
 						: 'justASimpleString';
-					const APIUrl = \`${formattedCategoryIds}\`;
+					ids.length;
 				}
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				function updateData() {
+					const obj = {
+						foo: 'bar',
+						bar: 'foo',
+						life: 'ray',
+					}
+
+					const ids = Object.keys(obj).length
+						? 'superLongStringSoThatItForcesTheLineToBeWrapped'
+						: 'justASimpleString';
+
+					ids.length;
+				}
+			`,
 		},
 		{
 			code: `
 				const obj = {
 					foo: 'bar',
 					bar: 'foo',
-					hi: 'bryce',
+					life: 'ray',
 				}
-			  	
+
 				const {foo} = obj;
 				const length = foo.length;
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const obj = {
+					foo: 'bar',
+					bar: 'foo',
+					life: 'ray',
+				}
+				
+				const {foo} = obj;
+
+				const length = foo.length;
+			`,
 		},
 		{
 			code: `
 				const obj = {
 					foo: 'bar',
 					bar: 'foo',
-					hi: 'bryce',
+					life: 'ray',
 				}
-			  	
-				const {foo, bar, hi} = obj;
-				const length = hi.length;
+
+				const {foo, bar, life} = obj;
+				const length = life.length;
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const obj = {
+					foo: 'bar',
+					bar: 'foo',
+					life: 'ray',
+				}
+
+				const {foo, bar, life} = obj;
+
+				const length = life.length;
+			`,
 		},
 		{
 			code: `
@@ -109,36 +163,53 @@ ruleTester.run('blank-line-declaration-usage', rule, {
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const filePath = context.getFilename();
+
+				const filename = path.basename(something, filePath);
+			`,
 		},
 		{
 			code: `
 				for (const file of files) {
 					const contents = readFileAsync(file, 'utf8');
 					const length = contents.length;
-				}			  
+				}
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				for (const file of files) {
+					const contents = readFileAsync(file, 'utf8');
+
+					const length = contents.length;
+				}
+			`,
 		},
 		{
 			code: `
-				var cbSpy = sinon.spy();
-				prototype.rows = [cbSpy];			  
+				const cbSpy = sinon.spy();
+				prototype.rows = [cbSpy];
 			`,
 			errors: [
 				{
-					message: 'error msg',
-					type: 'VariableDeclaration',
+					message,
+					type: 'Identifier',
 				},
 			],
+			output: `
+				const cbSpy = sinon.spy();
+
+				prototype.rows = [cbSpy];
+			`,
 		},
 	],
 	valid: [
@@ -154,7 +225,7 @@ ruleTester.run('blank-line-declaration-usage', rule, {
 				const obj = {
 					foo: 'bar',
 					bar: 'foo',
-					hi: 'bryce',
+					life: 'ray',
 				}
 				
 				Object.keys(obj)
@@ -165,9 +236,9 @@ ruleTester.run('blank-line-declaration-usage', rule, {
 				const obj = {
 					foo: 'bar',
 					bar: 'foo',
-					hi: 'bryce',
+					life: 'ray',
 				}
-			  	
+
 				const {foo} = obj;
 				
 				const length = foo.length;