# @salesforce/schemas

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

Latest version **1.10.3** (published 2025-09-03) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @salesforce/schemas
pnpm add @salesforce/schemas
yarn add @salesforce/schemas
bun add @salesforce/schemas
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.10.3 |
| Published | 2025-09-03 |
| First published | 2020-05-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 132 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 41 |
| Author | Salesforce |
| Maintainers | demianbrecht, jye-sf, jburnie, kevinv11n, byao, pmdartus, jcourtner, dferro, duane.chew, ekashida, ravi.jayaramappa, mjrust, apapko, jleen-sfdc, jqian, cwallsf, dhagberg-sf, khawkins, mbettio, amphro, ire-npm-team-user, damilareolowoniyi, jodarove, sfdctaka, fernomac, jimjag, ivarley, jbartolotta-sfdc, dhersam, mmadialagan, dbreese-salesforce, ashokrudraraju, salesforce-releases, iamaziz, packagellama, hkii, adirasanam, nolanlawson, jasonschroeder-sfdc, danielshox, dme722, maward, jmsjtu, mobify, dlouvton, lwc-admin, abirchfieldsfdc, ww951206 |

## Links

- npm: https://www.npmjs.com/package/@salesforce/schemas
- Repository: https://github.com/forcedotcom/schemas
- Homepage: https://github.com/forcedotcom/schemas#readme
- Issues: https://github.com/forcedotcom/schemas/issues
- npm.io page: https://npm.io/package/@salesforce/schemas

## Recent versions

- 1.10.3 (latest) — 2025-09-03
- 1.10.4-qa.0 (qa) — 2025-11-24
- 1.10.2 — 2025-08-30
- 1.10.1 — 2025-08-30
- 1.10.0 — 2025-08-29
- 1.9.1 — 2025-06-30
- 1.9.0 — 2024-05-17
- 1.8.1 — 2024-05-14
- 1.7.0 — 2024-04-01
- 1.6.1 — 2023-10-26
- 1.6.0 — 2023-06-27
- 1.5.1 — 2023-03-10
- 1.5.0 — 2023-01-25
- 1.4.0 — 2022-11-09
- 1.3.1 — 2022-11-09
- … 11 more at https://npm.io/package/@salesforce/schemas/versions

## README

# Salesforce DX Schemas

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

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](https://forcedotcom.github.io/schemas/project-scratch-def.json/project-scratch-def.schema.json)
- Schema: [sfdx-project.json](https://forcedotcom.github.io/schemas/sfdx-project.json/sfdx-project.schema.json)

## Using the Schemas

If you are using the **[Salesforce Extensions for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode)** 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.

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

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

```javascript
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 `features-update` and `settings-update` 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

## Generating Schema from TS files

The `/src` folder contains the TS type used to generate the [`replacements`](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_string_replace.htm?q=replacements) project property.

You can define (or import and re-export) TS types and then use [this extension](https://marketplace.visualstudio.com/items?itemName=marcoq.vscode-typescript-to-json-schema). It adds a "Generate JSON Schema from type" action to your palette.

The results go into `/compiled`, which can be used to copy-paste into the project.

## Bugs and Feedback

To report issues or feedback with the schemas, open a bug on [GitHub](https://github.com/forcedotcom/schemas/issues).

---
_Source: https://npm.io/package/@salesforce/schemas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._