diff --git a/README.md b/README.md index 516c449..2be3727 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,3 @@ -# Salesforce DX Schemas +# Salesforce DX Schemas (Archived) -[![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). +The schemas that used to live here are now part of https://github.com/forcedotcom/sfdx-core.