Skip to content

Commit bca4c40

Browse files
committed
chore: update README
1 parent 44d2ccb commit bca4c40

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ export default [
8585
// By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly.
8686
// While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it,
8787
// explicitly specifying it ensures better compatibility and functionality.
88+
//
89+
// If non-serializable properties are included, running ESLint with the --cache flag will fail.
90+
// In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`)
8891
svelteConfig
8992
}
9093
}
@@ -143,6 +146,9 @@ export default ts.config(
143146
// By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly.
144147
// While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it,
145148
// explicitly specifying it ensures better compatibility and functionality.
149+
//
150+
// If non-serializable properties are included, running ESLint with the --cache flag will fail.
151+
// In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`)
146152
svelteConfig
147153
}
148154
}

docs/user-guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ export default [
5050
// By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly.
5151
// While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it,
5252
// explicitly specifying it ensures better compatibility and functionality.
53+
//
54+
// If non-serializable properties are included, running ESLint with the --cache flag will fail.
55+
// In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`)
5356
svelteConfig
5457
}
5558
}
@@ -108,6 +111,9 @@ export default ts.config(
108111
// By doing so, some rules in eslint-plugin-svelte will automatically read the configuration and adjust their behavior accordingly.
109112
// While certain Svelte settings may be statically loaded from svelte.config.js even if you don’t specify it,
110113
// explicitly specifying it ensures better compatibility and functionality.
114+
//
115+
// If non-serializable properties are included, running ESLint with the --cache flag will fail.
116+
// In that case, please remove the non-serializable properties. (e.g. `svelteConfig: { ...svelteConfig, kit: { ...svelteConfig.kit, typescript: undefined }}`)
111117
svelteConfig
112118
}
113119
}

0 commit comments

Comments
 (0)