prevent-abbreviations: Improve fix for retVal (#1953)

sindresorhus · Nov 8, 2022 · 25cd810 · 25cd810
1 parent f2f376a
commit 25cd810
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/rules/prevent-abbreviations.js b/rules/prevent-abbreviations.js
@@ -141,6 +141,16 @@ const getNameReplacements = (name, options, limit = 3) => {
 		samples,
 	} = cartesianProductSamples(combinations, limit);
 
+	// `retVal` -> `['returnValue', 'Value']` -> `['returnValue']`
+	for (const parts of samples) {
+		for (let index = parts.length - 1; index > 0; index--) {
+			const word = parts[index];
+			if (/^[A-Za-z]+$/.test(word) && parts[index - 1].endsWith(parts[index])) {
+				parts.splice(index, 1);
+			}
+		}
+	}
+
 	return {
 		total,
 		samples: samples.map(words => words.join('')),

diff --git a/test/prevent-abbreviations.mjs b/test/prevent-abbreviations.mjs
@@ -1261,6 +1261,39 @@ const tests = {
 			options: noExtendDefaultAllowListOptions,
 			errors: createErrors(),
 		},
+
+		// #1937
+		{
+			code: 'const expectedRetVal = "that should be ok";',
+			output: 'const expectedReturnValue = "that should be ok";',
+			errors: createErrors(),
+		},
+		{
+			code: 'const retVal = "that should be ok";',
+			output: 'const returnValue = "that should be ok";',
+			errors: createErrors(),
+		},
+		{
+			code: 'const retValue = "that should be ok";',
+			output: 'const returnValue = "that should be ok";',
+			errors: createErrors(),
+		},
+		{
+			code: 'const returnVal = "that should be ok";',
+			output: 'const returnValue = "that should be ok";',
+			errors: createErrors(),
+		},
+		{
+			code: 'const sendDmMessage = () => {};',
+			output: 'const sendDirectMessage = () => {};',
+			options: [{replacements: {dm: {directMessage: true}}}],
+			errors: createErrors(),
+		},
+		{
+			code: 'const ret_val = "that should be ok";',
+			output: 'const returnValue_value = "that should be ok";',
+			errors: createErrors(),
+		},
 	],
 };