docs: Add hint in lib vite config, warning against using aliases

LinusBorg · Nov 11, 2023 · ffabdf3 · ffabdf3
1 parent 6aa25e2
commit ffabdf3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/lib/vite.config.ts b/packages/lib/vite.config.ts
@@ -5,6 +5,15 @@ import { fileURLToPath } from 'url'
 
 export default defineConfig({
 	plugins: [vue()],
+	resolve: {
+		alias: {
+			/*
+			 * We recommend to not use aliases in the lib's source,
+			 * because they will leak into the generated d.ts files and then
+			 * break the lib's types in the consuming app.
+			 */
+		},
+	},
 	build: {
 		lib: {
 			name: 'Lib', // TODO: CHANGE_ME