docs: standardize comment in jsconfig/tsconfig (#11788)

owenversteeg · benmccann · web-flow · commit 8f185a03e388 · 2024-03-14T20:53:26.000-07:00
Co-authored-by: Ben McCann &lt;322311+benmccann@users.noreply.github.com&gt;
diff --git a/.changeset/sweet-weeks-pretend.md b/.changeset/sweet-weeks-pretend.md
@@ -0,0 +1,5 @@
+---
+"create-svelte": patch
+---
+
+docs: update comment about path aliases
diff --git a/packages/create-svelte/shared/+checkjs/jsconfig.json b/packages/create-svelte/shared/+checkjs/jsconfig.json
@@ -11,7 +11,8 @@
 		"strict": true,
 		"moduleResolution": "bundler"
 	}
-	// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias and https://kit.svelte.dev/docs/configuration#files
+	// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
+	// except $lib which is handled by https://kit.svelte.dev/docs/configuration#files
 	//
 	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
 	// from the referenced tsconfig.json - TypeScript does not merge them in
diff --git a/packages/create-svelte/shared/+typescript/tsconfig.json b/packages/create-svelte/shared/+typescript/tsconfig.json
@@ -12,6 +12,7 @@
 		"moduleResolution": "bundler"
 	}
 	// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
+	// except $lib which is handled by https://kit.svelte.dev/docs/configuration#files
 	//
 	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
 	// from the referenced tsconfig.json - TypeScript does not merge them in

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"create-svelte": patch
 +---
++
 +docs: update comment about path aliases
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`"moduleResolution": "bundler"`
`13`	`13`	`}`
`14`	`14`	`// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias`
	`15`	`+ // except $lib which is handled by https://kit.svelte.dev/docs/configuration#files`
`15`	`16`	`//`
`16`	`17`	`// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes`
`17`	`18`	`// from the referenced tsconfig.json - TypeScript does not merge them in`