From bca4c40eff7da2d8b05236224de9452188f2ebcc Mon Sep 17 00:00:00 2001 From: baseballyama Date: Mon, 15 Sep 2025 18:12:59 +0900 Subject: [PATCH] chore: update README --- README.md | 6 ++++++ docs/user-guide.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index f2340d79b..abd85f3a6 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,9 @@ export default [ // By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly. // While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it, // explicitly specifying it ensures better compatibility and functionality. + // + // If non-serializable properties are included, running ESLint with the --cache flag will fail. + // In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`) svelteConfig } } @@ -143,6 +146,9 @@ export default ts.config( // By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly. // While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it, // explicitly specifying it ensures better compatibility and functionality. + // + // If non-serializable properties are included, running ESLint with the --cache flag will fail. + // In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`) svelteConfig } } diff --git a/docs/user-guide.md b/docs/user-guide.md index 14c061354..f95baec5d 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -50,6 +50,9 @@ export default [ // By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly. // While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it, // explicitly specifying it ensures better compatibility and functionality. + // + // If non-serializable properties are included, running ESLint with the --cache flag will fail. + // In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`) svelteConfig } } @@ -108,6 +111,9 @@ export default ts.config( // By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly. // While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it, // explicitly specifying it ensures better compatibility and functionality. + // + // If non-serializable properties are included, running ESLint with the --cache flag will fail. + // In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`) svelteConfig } }