@salesforce/schemas

This repository contains the spec and schema for the Scratch Org Definition Configuration file and `sfdx-project.json` file.

Usage no npm install needed!

<script type="module">
  import salesforceSchemas from 'https://cdn.skypack.dev/@salesforce/schemas';
</script>

README

Salesforce DX Schemas

JSON Schemas help with validation and code completion of json files. Below are the schemas that are available in this repository.

Schema: project-scratch-def.json
Schema: sfdx-project.json

Using the Schemas

If you are using the Salesforce Extensions for Visual Studio Code these schemas are already included for you.

For most other editors, you can use the schemas by adding the $schema property to the top of your JSON file with the link to the schema document as shown below.

{
  "$schema": "https://raw.githubusercontent.com/forcedotcom/schemas/main/sfdx-project.schema.json"
  //...
}

You can also use these schemas programatially. For example, Salesforce CLI uses these schema to do certain validation.

const schemas = require('@salesforce/schemas');
const projectJsonSchema = require(schemas['sfdx-project']);
// OR
const projectJsonSchema = require('@salesforce/schema/sfdx-project-schema.json']);

Updating project-scratch-def.schema.json

Run the update-scratch-def-*.js scripts on every major release and open a PR with the new changes against the main branch to keep the schema files up to date.

Bugs and Feedback

To report issues or feedback with the schemas, open a bug on GitHub.