VS Code Auto-Completion

You can draft Pipeline Specifications (PPS) in JSON or YAML in VS Code with the help of intelligent code completion. This guide will show you how to add auto-completion to VS Code for Pachyderm pipelines.

Once installed, add .pipeline.json or .pipeline.yaml to the end of your file name and you will have access to auto-completion.

Before You Start #

• You must have VS Code installed on your local machine.

How to Add Auto-Completion to VS Code #

JSON #

1. Open VS Code.
2. Navigate to Code > Profiles (Default) > Show Profile Contents.
3. Open the settings.json file.
4. Add the following to your configuration:

   "json.schemas": [
   {
     "fileMatch": ["*.pipeline.json"],
     "url": "https://raw.githubusercontent.com/pachyderm/pachyderm/master/src/internal/jsonschema/pps_v2/CreatePipelineRequest.schema.json"
   }
   ]

   

Now all files with the .pipeline.json extension will have access to auto-completion.

YAML #

1. Install the Red Hat YAML Extension.
2. Navigate to Code > Profiles (Default) > Show Profile Contents.
3. Open the settings.json file.
4. Add the following to your configuration:

   "yaml.schemas": {
   "https://raw.githubusercontent.com/pachyderm/pachyderm/master/src/internal/jsonschema/pps_v2/CreatePipelineRequest.schema.json": "/**/*.pipeline.yaml"
   }

   

Now all files with the .pipeline.yaml extension will have access to auto-completion.