fix(eslint-plugin): [no-base-to-string] make error message more nuanced (typescript-eslint#9281)

Josh-Cena · web-flow · commit cb1720d59eb8 · 2024-06-05T12:36:49.000-04:00
* refactor(eslint-plugin): [no-base-to-string] make error message more nuanced

* Fix test
diff --git a/packages/eslint-plugin/docs/rules/no-base-to-string.mdx b/packages/eslint-plugin/docs/rules/no-base-to-string.mdx
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 > See **https://typescript-eslint.io/rules/no-base-to-string** for documentation.
 
 JavaScript will call `toString()` on an object when it is converted to a string, such as when `+` adding to a string or in `${}` template literals.
-The default Object `.toString()` returns `"[object Object]"`, which is often not what was intended.
+The default Object `.toString()` uses the format `"[object Object]"`, which is often not what was intended.
 This rule reports on stringified values that aren't primitives and don't define a more useful `.toString()` method.
 
 > Note that `Function` provides its own `.toString()` that returns the function's code.
diff --git a/packages/eslint-plugin/docs/rules/restrict-template-expressions.mdx b/packages/eslint-plugin/docs/rules/restrict-template-expressions.mdx
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 > See **https://typescript-eslint.io/rules/restrict-template-expressions** for documentation.
 
 JavaScript automatically [converts an object to a string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String#string_coercion) in a string context, such as when concatenating it with a string using `+` or embedding it in a template literal using `${}`.
-The default `toString()` method of objects returns `"[object Object]"`, which is often not what was intended.
+The default `toString()` method of objects uses the format `"[object Object]"`, which is often not what was intended.
 This rule reports on values used in a template literal string that aren't strings, optionally allowing other data types that provide useful stringification results.
 
 :::note
diff --git a/packages/eslint-plugin/src/rules/no-base-to-string.ts b/packages/eslint-plugin/src/rules/no-base-to-string.ts
@@ -28,7 +28,7 @@ export default createRule<Options, MessageIds>({
     },
     messages: {
       baseToString:
-        "'{{name}}' {{certainty}} evaluate to '[object Object]' when stringified.",
+        "'{{name}}' {{certainty}} use Object's default stringification format ('[object Object]') when stringified.",
     },
     schema: [
       {
diff --git a/packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-base-to-string.shot b/packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-base-to-string.shot

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export default createRule<Options, MessageIds>({`
`28`	`28`	`},`
`29`	`29`	`messages: {`
`30`	`30`	`baseToString:`
`31`		`- "'{{name}}' {{certainty}} evaluate to '[object Object]' when stringified.",`
	`31`	`+ "'{{name}}' {{certainty}} use Object's default stringification format ('[object Object]') when stringified.",`
`32`	`32`	`},`
`33`	`33`	`schema: [`
`34`	`34`	`{`