Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@sveltejs/adapter-netlify
Advanced tools
@sveltejs/adapter-netlify - npm Package Compare versions
Comparing version 1.0.3 to 1.0.4
| { | ||
| "name": "@sveltejs/adapter-netlify", | ||
| "version": "1.0.3", | ||
| "version": "1.0.4", | ||
| "repository": { | ||
@@ -41,3 +41,3 @@ "type": "git", | ||
| "uvu": "^0.5.6", | ||
| "@sveltejs/kit": "^1.1.1" | ||
| "@sveltejs/kit": "^1.1.3" | ||
| }, | ||
@@ -44,0 +44,0 @@ "peerDependencies": { |
108
README.md
@@ -5,112 +5,10 @@ # adapter-netlify | ||
| If you're using [adapter-auto](../adapter-auto), you don't need to install this unless you need to specify Netlify-specific options, since it's already included. | ||
| If you're using [adapter-auto](https://kit.svelte.dev/docs/adapter-auto), you don't need to install this unless you need to specify Netlify-specific options, since it's already included. | ||
| ## Installation | ||
| ## Docs | ||
| ```bash | ||
| npm i -D @sveltejs/adapter-netlify | ||
| ``` | ||
| [Docs](https://kit.svelte.dev/docs/adapter-netlify) | ||
| You can then configure it inside of `svelte.config.js`: | ||
| ```js | ||
| import adapter from '@sveltejs/adapter-netlify'; | ||
| export default { | ||
| kit: { | ||
| // default options are shown | ||
| adapter: adapter({ | ||
| // if true, will create a Netlify Edge Function rather | ||
| // than using standard Node-based functions | ||
| edge: false, | ||
| // if true, will split your app into multiple functions | ||
| // instead of creating a single one for the entire app. | ||
| // if `edge` is true, this option cannot be used | ||
| split: false | ||
| }) | ||
| } | ||
| }; | ||
| ``` | ||
| Then, make sure you have a [netlify.toml](https://docs.netlify.com/configure-builds/file-based-configuration) file in the project root. This will determine where to write static assets based on the `build.publish` settings, as per this sample configuration: | ||
| ```toml | ||
| [build] | ||
| command = "npm run build" | ||
| publish = "build" | ||
| ``` | ||
| If the `netlify.toml` file or the `build.publish` value is missing, a default value of `"build"` will be used. Note that if you have set the publish directory in the Netlify UI to something else then you will need to set it in `netlify.toml` too, or use the default value of `"build"`. | ||
| ### Node version | ||
| New projects will use Node 16 by default. However, if you're upgrading a project you created a while ago it may be stuck on an older version. See [the Netlify docs](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) for details on manually specifying Node 16 or newer. | ||
| ## Netlify Edge Functions (beta) | ||
| SvelteKit supports the beta release of [Netlify Edge Functions](https://docs.netlify.com/netlify-labs/experimental-features/edge-functions/). If you pass the option `edge: true` to the `adapter` function, server-side rendering will happen in a Deno-based edge function that's deployed close to the site visitor. If set to `false` (the default), the site will deploy to standard Node-based Netlify Functions. | ||
| ```js | ||
| import adapter from '@sveltejs/adapter-netlify'; | ||
| export default { | ||
| kit: { | ||
| adapter: adapter({ | ||
| // will create a Netlify Edge Function using Deno-based | ||
| // rather than using standard Node-based functions | ||
| edge: true | ||
| }) | ||
| } | ||
| }; | ||
| ``` | ||
| ## Netlify alternatives to SvelteKit functionality | ||
| You may build your app using functionality provided directly by SvelteKit without relying on any Netlify functionality. Using the SvelteKit versions of these features will allow them to be used in dev mode, tested with integration tests, and to work with other adapters should you ever decide to switch away from Netlify. However, in some scenarios you may find it beneficial to use the Netlify versions of these features. One example would be if you're migrating an app that's already hosted on Netlify to SvelteKit. | ||
| ### Using Netlify Redirect Rules | ||
| During compilation, redirect rules are automatically appended to your `_redirects` file. (If it doesn't exist yet, it will be created.) That means: | ||
| - `[[redirects]]` in `netlify.toml` will never match as `_redirects` has a [higher priority](https://docs.netlify.com/routing/redirects/#rule-processing-order). So always put your rules in the [`_redirects` file](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file). | ||
| - `_redirects` shouldn't have any custom "catch all" rules such as `/* /foobar/:splat`. Otherwise the automatically appended rule will never be applied as Netlify is only processing [the first matching rule](https://docs.netlify.com/routing/redirects/#rule-processing-order). | ||
| ### Using Netlify Forms | ||
| 1. Create your Netlify HTML form as described [here](https://docs.netlify.com/forms/setup/#html-forms), e.g. as `/routes/contact.svelte`. (Don't forget to add the hidden `form-name` input element!) | ||
| 2. Netlify's build bot parses your HTML files at deploy time, which means your form must be [prerendered](https://kit.svelte.dev/docs/page-options#prerender) as HTML. You can either add `export const prerender = true` to your `contact.svelte` to prerender just that page or set the `kit.prerender.force: true` option to prerender all pages. | ||
| 3. If your Netlify form has a [custom success message](https://docs.netlify.com/forms/setup/#success-messages) like `<form netlify ... action="/success">` then ensure the corresponding `/routes/success.svelte` exists and is prerendered. | ||
| ### Using Netlify Functions | ||
| With this adapter, SvelteKit endpoints are hosted as [Netlify Functions](https://docs.netlify.com/functions/overview/). Netlify function handlers have additional context, including [Netlify Identity](https://docs.netlify.com/visitor-access/identity/) information. You can access this context via the `event.platform.context` field inside your hooks and `+page.server` or `+layout.server` endpoints. These are [serverless functions](https://docs.netlify.com/functions/overview/) when the `edge` property is `false` in the adapter config or [edge functions](https://docs.netlify.com/edge-functions/overview/#app) when it is `true`. | ||
| ```js | ||
| // +page.server.js | ||
| export const load = async (event) => { | ||
| const context = event.platform.context; | ||
| console.log(context); // shows up in your functions log in the Netlify app | ||
| }; | ||
| ``` | ||
| Additionally, you can add your own Netlify functions by creating a directory for them and adding the configuration to your `netlify.toml` file. For example: | ||
| ```toml | ||
| [build] | ||
| command = "npm run build" | ||
| publish = "build" | ||
| [functions] | ||
| directory = "functions" | ||
| ``` | ||
| ## Troubleshooting | ||
| ### Accessing the file system | ||
| You can't access the file system through methods like `fs.readFileSync` in Serverless/Edge environments. If you need to access files that way, do that during building the app through [prerendering](https://kit.svelte.dev/docs/page-options#prerender). If you have a blog for example and don't want to manage your content through a CMS, then you need to prerender the content (or prerender the endpoint from which you get it) and redeploy your blog everytime you add new content. | ||
| ## Changelog | ||
| [The Changelog for this package is available on GitHub](https://github.com/sveltejs/kit/blob/master/packages/adapter-netlify/CHANGELOG.md). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.74%
792354
- Number of lines in readme file
- decreased by-87.93%
14
No dependency changes