netlify-dev-plugin

Netlify CLI plugin for local dev experience. If you're interested to work on Netlify Dev and other product initatives fulltime, we are hiring.

What is Netlify Dev?

Netlify Dev brings the power of Netlify's Edge Logic layer, serverless functions and add-on ecosystem to your local machine. It runs Netlify's production routing engine in a local dev server to make all redirects, proxy rules, function routes or add-on routes available locally and injects the correct environment variables from your site environment, installed add-ons or your netlify.toml file into your build and function environment.

It automatically detects common tools like Gatsby, Hugo, React Static, Eleventy, and more, to give a zero config setup for your local dev server and can help scaffolding new functions as you work on them.

Prerequisites

• You should have the latest Netlify CLI version. Run npm install -g netlify-cli to be sure.
• You should be logged in on Netlify CLI
• Your project should be linked to a siteID on Netlify (using netlify init or netlify link). You can confirm this has been done if you have a .netlify folder with a state.json file containing your siteID.

This is how we pull down your build environment variables and manage your addons on your local machine.

Usage

• netlify dev start a local dev server for the build tool you're using
• netlify dev:exec <command> runs a shell command within the netlify dev environment
• netlify functions:create bootstrap a new function

As these commands are expected to be frequently used, it may be helpful to define aliases in your terminal (Mac: bash, zsh, Windows: doskey, registry) to your personal preference. For example:

## ~/.zshrc
alias ndeploy="netlify deploy --prod"
alias nd="netlify dev"
alias ndl="netlify dev --live"
alias nfc="netlify functions:create"
alias ndx="netlify dev:exec "

Netlify Dev usage

USAGE
  $ netlify dev

OPTIONS
  -c, --command=command      command to run
  -f, --functions=functions  Specify a functions folder to serve
  -o, --offline              disables any features that require network access
  -p, --port=port            Specify port of netlify dev
  -l, --live                 Start a public live session

DESCRIPTION
  The dev command will run a local dev server with Netlify's Edge Logic proxies and redirects, serverless functions, and addons

EXAMPLES
  $ netlify dev
  $ netlify dev -c "yarn start"
  $ netlify dev -c hugo

COMMANDS
  dev:exec  Exec command

Live Share

To share your ongoing dev session with a coworker, just run Netlify Dev with a --live flag:

netlify dev --live

You will get a URL that looks like https://clever-cray-2aa156-6639f3.netlify.live/. This can be accessed by anyone as long as you keep your session open.

Note: there are currently known issues with ending the live session alongside your webdevserver, as well as with live reloading. We are working on fixing it, and would appreciate repro cases. In the mean time you can run ps aux | grep live-tunnel and kill these sessions manually.

Project detection

Netlify Dev will attempt to detect the SSG or build command that you are using, and run these on your behalf, while adding other development utilities. If you have a JavaScript project, it looks for the best package.json script to run for you, using simple heuristics, so you can use the full flexibility of npm scripts. We may add more intelligence to this in future.

Overriding the detectors: The number of project types which Netlify Dev can detect is growing, but if yours is not yet supported (contributions welcome!), you can instruct Netlify Dev to run the project on your behalf by declaring it in a [dev] block of your netlify.toml file.

# sample dev block in the toml
# note: each of these fields are OPTIONAL and should only be used if you need an override
[dev]
  command = "yarn start" # Command to start your dev server
  port = 3000 # Port that the dev server will be listening on
  publish = "dist" # If you use a _redirect file, provide the path to your static content folder

There will be a number of ports that you will encounter when using Netlify Dev, especially when running a static site generator like Gatsby which has its own dev server. All the port numbers can be a bit confusing, so here is a brief explainer.

• If your SSG has a devserver on port 8000 for example, Netlify Dev needs to be told to proxy that port so it can merge it in with the rest of the local Netlify environment (say, running on port 8888), which is what you want to get the full Netlify Dev experience with Functions, Redirects, and so on.
• If you're running a project we have a detector for, we hardcode those conventional ports so you don't have to supply it yourself. If we have multiple detectors that match, we'll ask you to choose.
• However, sometimes you're using some other project (we welcome contributions for detectors!) or just have a custom port you want Netlify Dev to point to for some reason. This is when you go to the netlify.toml [dev] block to specify exactly what port we should listen to.

As for which port to use while doing local development in Netlify Dev, always look for this box in your console output and use that:

   ┌──────────────────────────────────────────────────────────────┐
   │                                                              │
   │   [Netlify Dev] Server now ready on http://localhost:64939   │
   │                                                              │
   └──────────────────────────────────────────────────────────────┘

Redirects

Netlify Dev has the ability emulate the redirect capability Netlify provide on the ADN in your local environment. The same redirect rules which you configure to run on the edge, will also work in your local builds.

Netlify dev supports redirect rules defined in either _redirects or netlify.toml files.

The order of precedence for applying redirect rules is:

1. _redirects file (in the project's publish folder)
2. netlify.toml file (in the project's publish folder)
3. netlify.toml file (in the project's root folder)

See the Redirects Documentation for more information on Netlify's redirect and proxying capabilities.

Netlify Functions

Netlify can also create serverless functions for you locally as part of Netlify Functions. The serverless functions can then be run by Netlify Dev in the same way that wold be when deployed to the cloud.

A number of function templates are available to get you started, and you can add your own utility functions to suit your own project development needs.

Create a new function

$ netlify functions:create

# Create a new function from one of the
# available templates offered when prompted (see below)
$ netlify functions:create

# alternatives
$ netlify functions:create hello-world # Create a new function with a given name
$ netlify functions:create --name hello-world # same

# Create a new function by cloning a template from a remote url
# organised with dependencies installed into a subdirectory
$ netlify functions:create hello-world --url https://github.com/netlify-labs/all-the-functions/tree/master/functions/9-using-middleware

Writing your own Function Templates

Function templates can specify addons that they rely on as well as execute arbitrary code after installation in an onComplete hook, if a special .netlify-function-template.js file exists in the directory:

// .netlify-function-template.js
module.exports = {
  addons: [
    {
      addonName: "fauna",
      addonDidInstall: () => {} // post install function to run after installing addon, eg. for setting up schema
    }
  ],
  onComplete() {
    console.log(`custom-template function created from template!`);
  }
};

Instead of using our basic templates, you can use your own by passing it with a --url flag: netlify functions:create hello-world --url https://github.com/netlify-labs/all-the-functions/tree/master/functions/9-using-middleware, specifying any addons and postinstall/complete steps as shown above.

Function Builders, Function Builder Detection, and Relationship with netlify-lambda

Existing users of netlify-lambda should have no change to their workflow by switching to netlify dev. One immediate benefit is no need for proxying since Netlify Dev does that for you.

Why Function Builders

Notice that all the functions created by netlify functions:create require no build step. This is intentional: we want to remain agnostic of build tooling and thereby create clear expectations: You give us a folder of functions, and we simply serve it (This is called zip-it-and-ship-it). If you want to build that folder from a separate source folder, that is entirely under your control. Use whatever tool you like.

This can be helpful, for example, to use ES modules syntax (e.g. import/export) via webpack, babel transforms via babel-cli or babel-loader, or strict type-checking and transpilation with TypeScript's tsc or other webpack loaders.

We'll call this category of tools function builders. In fact, we do maintain an open source function builder dedicated to the task of transforming serverless functions from source to destination via webpack, called netlify-lambda. We maintain a comparison between Netlify Dev and netlify-lambda on its README as well as advice on when to use which or both.

Function Builder Detection

We don't expect everyone to use function builders, but we expect many will, and want to provide helpful defaults that "just work" for this. To do that, we use a similar detection concept to project detectors, and look for common function builder setups.

With this feature, pre-Netlify Dev projects like https://github.com/netlify/create-react-app-lambda can immediately use the netlify dev command with no change to code. Currently, we only offer detection for scripts with netlify-lambda build $SRCFOLDER. More ideas are welcome.

Netlify Dev will watch netlify-lambda's source folder and rebuild whenever the source file changes, eliminating the need for netlify-lambda serve since we dont want a duplicate functions server.

Bring Your Own Function Builder

We may offer detection for more function builders in future, and also let you specify function build commands in the netlify.toml [dev] block. Please share your usecase with us if you are likely to need this.

Using Add-ons

Add-ons are a way for Netlify users to extend the functionality of their Jamstack site/app.

Check out Add-on docs here.

To try out an add-on with Netlify dev, run the netlify addons:create command:

netlify addons:create fauna

The above command will install the FaunaDB add-on and provision a noSQL database for your site to leverage. The FaunaDB add-on injects environment variables into your site's build process and the serverless functions.

Or install this one click example.

After you have installed an add-on, it will be visible with the netlify addons:list command inside your site's current working directory. You can use netlify addons:delete $ADDONNAME to delete your addon instance.

For now, it is important to include instructions to create addons for each member of your team, as there is no way to specify addons inside of netlify.toml. We are working on this.

Contributing/Local Development

Thanks for contributing! You'll need to follow these steps to run Netlify CLI and netlify-dev-plugin locally:

0. uninstall any globally installed versions of netlify-cli
1. clone and install deps for https://github.com/netlify/cli
2. npm link from inside the cli folder
3. clone and install deps for this repo
4. inside the netlify-dev-plugin folder, run yarn link
5. inside the cli folder, run yarn link "netlify-dev-plugin"

Now you're both ready to start testing netlify dev and to contribute to the project! Note these are untested instructions, please get in touch if you're unable to follow them clearly and we'll work with you. Or ping @swyx.