Skip to content
Edit on GitHub

IDE Plugins and Syntax Highlighting

When files or directories are added to the project, or stages to a pipeline, DVC files are created or updated. These use a human-readable YAML format.

In the case of dvc.yaml, we maintain a schema description that can enable IDE syntax checks and auto-completion.

Visual Studio Code

Install the DVC Extension for VS Code to use DVC right from your IDE!

Enable enhanced IntelliSense on dvc.yaml files by installing the YAML extension.

To make dvc.lock and .dvc files recognized as YAML, add this to settings.json:

"files.associations": {
    "*.dvc": "yaml",
    "dvc.lock": "yaml"
}

JetBrain IDEs (PyCharm, Intellij IDEA, etc.)

These IDEs should ask how to associate file types for dvc.lock and .dvc files when you first open one of them. If not, follow this guide to set them manually.

PyCharm should provide auto-completion and syntax checks for dvc.yaml files out of the box. If not, refer to these instructions.

Vim

In order to recognize dvc.lock and .dvc files as YAML in Vim, you should add:

" DVC
autocmd! BufNewFile,BufRead Dvcfile,*.dvc,dvc.lock setfiletype yaml

to your ~/.vimrc(to be created if it doesn't exist).

Doom Emacs

In order to recognize dvc.lock and .dvc files as YAML in Doom Emacs, add

(use-package! yaml-mode
  :config
  (add-to-list 'auto-mode-alist '("\\.dvc" . yaml-mode))
  (add-to-list 'auto-mode-alist '("dvc.lock" . yaml-mode))
  )

to your ~/.doom.d/config.el.

Content

🐛 Found an issue? Let us know! Or fix it:

Edit on GitHub

Have a question? Join our chat, we will help you:

Discord Chat