Set up VS Code for Lightdash

Configure YAML validation in VS Code so schema and formatting issues in your Lightdash model, chart, and dashboard files are flagged as you edit.

YAML validation

If you edit your Lightdash YAML in VS Code — dbt model schema files, or charts and dashboards managed as content as code — set up schema validation so formatting and configuration issues are flagged before you compile or upload. You get autocomplete for supported properties and inline errors for invalid ones, using the same logic Lightdash applies when compiling your project.

1. Install the YAML extension

   Install the YAML extension for VS Code.

2. Map the Lightdash schemas in settings.json

   Add the schemas to your settings.json file. Read this guide for details on how to edit settings.json.

   settings.json

   "yaml.schemas": {
     "https://raw.githubusercontent.com/lightdash/lightdash/main/packages/common/src/schemas/json/lightdash-dbt-2.0.json": [
       "/**/models/**/*.yml",
       "/**/models/**/*.yaml"
     ],
     "https://raw.githubusercontent.com/lightdash/lightdash/main/packages/common/src/schemas/json/chart-as-code-1.0.json": [
       "lightdash/charts/*.yml"
     ],
     "https://raw.githubusercontent.com/lightdash/lightdash/main/packages/common/src/schemas/json/dashboard-as-code-1.0.json": [
       "lightdash/dashboards/*.yml"
     ]
   }
   

   Adjust the chart and dashboard globs to match where you write content as code. The defaults above assume lightdash download wrote to lightdash/charts/ and lightdash/dashboards/.

Once the extension is installed and your settings are updated, you’ll see warnings like this when working on your schema.yml files.