fix: Better error message for unserializable parser (#19384)

nzakas · mdjermanovic · web-flow · commit 61d99e38f248 · 2025-02-01T12:23:12.000+01:00
* fix: Better error message for unserializable parser fixes #19322 * Update messages/config-serialize-function.js Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update messages/config-serialize-function.js Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
diff --git a/lib/config/config.js b/lib/config/config.js
@@ -110,7 +110,12 @@ function languageOptionsToJSON(languageOptions, objectKey = "languageOptions") {
             }
 
             if (typeof value === "function") {
-                throw new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
+                const error = new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
+
+                error.messageTemplate = "config-serialize-function";
+                error.messageData = { key, objectKey };
+
+                throw error;
             }
 
         }
diff --git a/messages/config-serialize-function.js b/messages/config-serialize-function.js
@@ -0,0 +1,28 @@
+"use strict";
+
+module.exports = function({ key, objectKey }) {
+
+    // special case for parsers
+    const isParser = objectKey === "parser" && (key === "parse" || key === "parseForESLint");
+    const parserMessage = `
+    This typically happens when you're using a custom parser that does not
+provide a "meta" property, which is how ESLint determines the serialized
+representation. Please open an issue with the maintainer of the custom parser
+and share this link:
+
+https://eslint.org/docs/latest/extend/custom-parsers#meta-data-in-custom-parsers
+`.trim();
+
+    return `
+The requested operation requires ESLint to serialize configuration data,
+but the configuration key "${objectKey}.${key}" contains a function value,
+which cannot be serialized.
+
+${
+    isParser ? parserMessage : "Please double-check your configuration for errors."
+}
+
+If you still have problems, please stop by https://eslint.org/chat/help to chat
+with the team.
+`.trimStart();
+};

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,12 @@ function languageOptionsToJSON(languageOptions, objectKey = "languageOptions") {`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`if (typeof value === "function") {`
`113`		- throw new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
	`113`	+ const error = new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
	`114`	`+`
	`115`	`+ error.messageTemplate = "config-serialize-function";`
	`116`	`+ error.messageData = { key, objectKey };`
	`117`	`+`
	`118`	`+ throw error;`
`114`	`119`	`}`
`115`	`120`
`116`	`121`	`}`