feat: Better documentation of server-only stuff

danfry1 · Aug 31, 2022 · 6b584b8 · 6b584b8
1 parent d35c476
commit 6b584b8
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 0 deletions.
diff --git a/documentation/docs/08-server-only-modules b/documentation/docs/08-server-only-modules
@@ -0,0 +1,46 @@
+---
+title: Server-Only Modules
+---
+
+SvelteKit cares about security. When writing your backend and frontend in the same repository, it can be easy to accidentally import sensitive data into your front-end code (environment variables containing API keys, for example). SvelteKit provides a way to prevent this entirely: Server-Only Modules. We export a few of these ourselves: See the private [`$env`](modules#$env-dynamic-private) modules.
+
+Thankfully, we don't keep all of this to ourselves. You can declare your module as server-only as well by placing it anywhere in your `$lib` directory and naming it `*.server.js` (or `ts`, etc.) Then, no matter how many hops you jump through, importing it into client code...
+
+```js
+// $lib/bad.server.js
+export const shouldExplode = 'boom';
+
+// $lib/hop-1.js
+export { shouldExplode } from '$lib/bad.server.js';
+
+// $lib/hop-2.js
+export { shouldExplode } from '$lib/hop-1.js';
+
+// $lib/hop-3.js
+export { shouldExplode } from '$lib/hop-2.js';
+
+// $lib/hop-4.js
+export { shouldExplode } from '$lib/hop-3.js';
+
+// src/routes/+page.svelte
+<script>
+	import { shouldExplode } from '$lib/hop-4.js';
+</script>
+
+<p>{shouldExplode}</p>
+```
+
+...will generate a helpful error.
+
+```bash
+[vite-plugin-svelte-kit] Cannot import $lib/bad.server.js into client-side code:
+- .svelte-kit/generated/nodes/2.js
+  - src/routes/+page.svelte
+    - $lib/hop-4.js
+      - $lib/hop-3.js
+        - $lib/hop-2.js
+          - $lib/hop-1.js
+            - $lib/bad.server.js
+```
+
+Note: This feature works with simple dynamic imports (eg. `await import('$lib/bad.server.js')`), but it will not work with complex ones (` await import(``$lib/{myVar}``) `).
diff --git a/documentation/docs/08-service-workers.md → documentation/docs/09-service-workers.md b/documentation/docs/08-service-workers.md → documentation/docs/09-service-workers.md
diff --git a/documentation/docs/09-a-options.md → documentation/docs/10-a-options.md b/documentation/docs/09-a-options.md → documentation/docs/10-a-options.md
diff --git a/documentation/docs/10-events.md → documentation/docs/11-events.md b/documentation/docs/10-events.md → documentation/docs/11-events.md
diff --git a/documentation/docs/11-adapters.md → documentation/docs/12-adapters.md b/documentation/docs/11-adapters.md → documentation/docs/12-adapters.md
diff --git a/documentation/docs/12-page-options.md → documentation/docs/13-page-options.md b/documentation/docs/12-page-options.md → documentation/docs/13-page-options.md
diff --git a/documentation/docs/13-packaging.md → documentation/docs/14-packaging.md b/documentation/docs/13-packaging.md → documentation/docs/14-packaging.md
diff --git a/documentation/docs/14-cli.md → documentation/docs/15-cli.md b/documentation/docs/14-cli.md → documentation/docs/15-cli.md
diff --git a/documentation/docs/15-configuration.md → documentation/docs/16-configuration.md b/documentation/docs/15-configuration.md → documentation/docs/16-configuration.md
diff --git a/documentation/docs/16-types.md → documentation/docs/17-types.md b/documentation/docs/16-types.md → documentation/docs/17-types.md
diff --git a/documentation/docs/17-seo.md → documentation/docs/18-seo.md b/documentation/docs/17-seo.md → documentation/docs/18-seo.md
diff --git a/documentation/docs/18-assets.md → documentation/docs/19-assets.md b/documentation/docs/18-assets.md → documentation/docs/19-assets.md
diff --git a/documentation/docs/19-accessibility.md → documentation/docs/20-accessibility.md b/documentation/docs/19-accessibility.md → documentation/docs/20-accessibility.md