prefer-number-properties: Fix suggestion description (#635)

Author: fisker

rules/prefer-number-properties.js

@@ -3,8 +3,9 @@ const getDocumentationUrl = require('./utils/get-documentation-url');
 const isShadowed = require('./utils/is-shadowed');
 const renameIdentifier = require('./utils/rename-identifier');
 
-const methodMessageId = 'method';
-const propertyMessageId = 'property';
+const METHOD_ERROR_MESSAGE_ID = 'method-error';
+const METHOD_SUGGESTION_MESSAGE_ID = 'method-suggestion';
+const PROPERTY_ERROR_MESSAGE_ID = 'property-error';
 
 const methods = {
 	// Safe
@@ -50,7 +51,7 @@ const create = context => {
 
 			const problem = {
 				node,
-				messageId: methodMessageId,
+				messageId: METHOD_ERROR_MESSAGE_ID,
 				data: {
 					name
 				}
@@ -61,7 +62,15 @@ const create = context => {
 			if (isSafe) {
 				problem.fix = fix;
 			} else {
-				problem.suggest = [{messageId: methodMessageId, fix}];
+				problem.suggest = [
+					{
+						messageId: METHOD_SUGGESTION_MESSAGE_ID,
+						data: {
+							name
+						},
+						fix
+					}
+				];
 			}
 
 			context.report(problem);
@@ -89,7 +98,7 @@ const create = context => {
 			const {name} = node;
 			context.report({
 				node,
-				messageId: propertyMessageId,
+				messageId: PROPERTY_ERROR_MESSAGE_ID,
 				data: {
 					name
 				},
@@ -108,8 +117,9 @@ module.exports = {
 		},
 		fixable: 'code',
 		messages: {
-			[methodMessageId]: 'Prefer `Number.{{name}}()` over `{{name}}()`.',
-			[propertyMessageId]: 'Prefer `Number.{{name}}` over `{{name}}`.'
+			[METHOD_ERROR_MESSAGE_ID]: 'Prefer `Number.{{name}}()` over `{{name}}()`.',
+			[METHOD_SUGGESTION_MESSAGE_ID]: 'Replace `{{name}}()` with `Number.{{name}}()`.',
+			[PROPERTY_ERROR_MESSAGE_ID]: 'Prefer `Number.{{name}}` over `{{name}}`.'
 		}
 	}
 };

test/prefer-number-properties.js

@@ -4,8 +4,9 @@ import {outdent} from 'outdent';
 import rule from '../rules/prefer-number-properties';
 
 const ruleId = 'prefer-number-properties';
-const methodMessageId = 'method';
-const propertyMessageId = 'property';
+const METHOD_ERROR_MESSAGE_ID = 'method-error';
+const METHOD_SUGGESTION_MESSAGE_ID = 'method-suggestion';
+const PROPERTY_ERROR_MESSAGE_ID = 'property-error';
 
 const methods = {
 	parseInt: {
@@ -36,20 +37,40 @@ const typescriptRuleTester = avaRuleTester(test, {
 	parser: require.resolve('@typescript-eslint/parser')
 });
 
-const invalidMethodTest = ({code, output, name}) => {
-	const isSafe = methods[name].safe;
+const createError = name => {
+	const {safe} = methods[name];
 
 	const error = {
-		messageId: methodMessageId,
+		messageId: METHOD_ERROR_MESSAGE_ID,
 		data: {
 			name
 		}
 	};
 
+	const suggestions = safe ? undefined : [
+		{
+			messageId: METHOD_SUGGESTION_MESSAGE_ID,
+			data: {
+				name
+			}
+		}
+	];
+
+	return {
+		...error,
+		suggestions
+	};
+};
+
+const invalidMethodTest = ({code, output, name}) => {
+	const {safe} = methods[name];
+
 	return {
 		code,
-		output: isSafe ? output : code,
-		errors: isSafe ? [{...error, suggestions: undefined}] : [{suggestions: [error]}]
+		output: safe ? output : code,
+		errors: [
+			createError(name)
+		]
 	};
 };
 
@@ -117,38 +138,10 @@ ruleTester.run(ruleId, rule, {
 				const d = isFinite(10);
 			`,
 			errors: [
-				{
-					messageId: methodMessageId,
-					data: {
-						name: 'parseInt'
-					}
-				},
-				{
-					messageId: methodMessageId,
-					data: {
-						name: 'parseFloat'
-					}
-				},
-				{
-					suggestions: [
-						{
-							messageId: methodMessageId,
-							data: {
-								name: 'isNaN'
-							}
-						}
-					]
-				},
-				{
-					suggestions: [
-						{
-							messageId: methodMessageId,
-							data: {
-								name: 'isFinite'
-							}
-						}
-					]
-				}
+				createError('parseInt'),
+				createError('parseFloat'),
+				createError('isNaN'),
+				createError('isFinite')
 			]
 		}
 	]
@@ -157,7 +150,7 @@ ruleTester.run(ruleId, rule, {
 // NaN
 const errorNaN = [
 	{
-		messageId: propertyMessageId,
+		messageId: PROPERTY_ERROR_MESSAGE_ID,
 		data: {
 			name: 'NaN'
 		}