Netlify for VS Code

Unofficial Netlify extension for VS Code.

New feature 🎉: Added a command Netlify: View deploy log to view the current branches' deploy log (build process) on Netlify

Features

• ✅ Deploy status and errors inside VS Code.
• 🌍 View latest production build with single click.
• 👀 Deploy preview straight from branch in VS Code.
• ⚡️ VS Code command palette integration.
• 👓 Netlify sidebar for in-depth deploy information

Documentation

• Netlify for VS Code
  • Features
  • Documentation
    • Video Overview
    • Status bar
    • Command palette
    • Settings
      • netlify.site_id
      • netlify.api_token
      • netlify.set_interval
      • netlify.build_hook
      • netlify.build_status_colors
    • Feedback

Video Overview

Status bar

The deployment monitor in the VS Code status bar should show one of the following states:

• Site is being deployed
• Site deploy was successful
• Site is waiting to be built
• Site deploy has failed

Command palette

You can run the following commands from the VS Code command palette:

• Netlify: View latest deploy
• Netlify: View production site
• Netlify: Trigger Netlify build
• Netlify: View deploy log

Settings

You can configure the extension straight from VS Code settings, by simply searching for Netlify. However, should you wish, you can also configure it straight from the settings.json file as follows:

{
  "netlify.site_id": "<site_name|api_id>",
  "netlify.api_token": "<personal_access_token>",
  "netlify.set_interval": "<number>",
  "netlify.build_status_colors": {
    "building": "<hex|name>",
    "enqueued": "<hex|name>",
    "deploy-successful": "<hex|name>",
    "error": "<hex|name>"
  }
}

These values are as follows:

netlify.site_id

The name of your site or api id can be used, you can find these details under Site detail. If you site name is my-site then you need to append .netlify.com so it will be my-site.netlify.com

netlify.api_token

The api_token is your Personal Access Token which can be found in User Settings, this will be used to authenticate private Netlify projects

netlify.set_interval

The default is 10000ms but you can set whatever polling interval you would like.

netlify.build_hook

This is your build hook endpoint for triggering a build process, you can create one via Build & deploy which can be found in a project's Settings

You can trigger the build hook straight from VS Code via the command pallette Netlify: Trigger build

netlify.build_status_colors

You can set the colors of the Netlify build status, makes it a bit easier is if the default colors do not play nicely with your theme. Here is the config for it via the settings.json

"netlify.build_status_colors": {
  "building": "<hex|name>",
  "enqueued": "<hex|name>",
  "deploy-successful": "<hex|name>",
  "error": "<hex|name>"
}

If you don't set a property with a color then it will just default to the internal color for that property

Feedback

If you love using this VS Code extension, please leave some feedback or rate it on the VS Code Marketplace it would be greatly appreciated.

If you have any ideas on how we can improve this project or maybe you found a bug, please let us know via a Github Issue

If you really, really love the project maybe consider sponsoring it