https://github.com/pklaschka/xd-manifest-schema
JSON schema for manifest.json files in plugins for Adobe XD CC
https://github.com/pklaschka/xd-manifest-schema
adobe adobe-xd json json-schema manifest-json plugin plugins schema
Last synced: about 1 month ago
JSON representation
JSON schema for manifest.json files in plugins for Adobe XD CC
- Host: GitHub
- URL: https://github.com/pklaschka/xd-manifest-schema
- Owner: pklaschka
- License: mit
- Created: 2019-03-10T11:21:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-02T17:22:03.000Z (over 5 years ago)
- Last Synced: 2025-04-10T23:03:32.758Z (about 1 month ago)
- Topics: adobe, adobe-xd, json, json-schema, manifest-json, plugin, plugins, schema
- Size: 8.79 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xd-manifest-schema
Unofficial JSON schema for `manifest.json` files for plugins for Adobe XD CC.
You can use the schema (`schema.json`) for validation or coding assistance by your IDE (with autocompletion, linting etc.)
Please note that this is still a very early version and I'm continually refining the schema, meaning there might still be some mistakes. If you find any issues, please feel free to open an issue or a PR here on GitHub so it can get fixed ASAP :smile:
## Usage
You can either download the schema from this repo or use the (always up-to-date) version hosted at https://xdplugins.pabloklaschka.de/xsd/xd-manifest.json.
Below, you'll find some guides on how to use the schema in editors and IDEs. If you don't find your IDE in the list, but know how this can be achieved there, please open a Pull Request adding your editor/IDE of choice to the list so everyone can be as productive as possible developing plugins :wink:
#### Jetbrains WebStorm (tested in version 2018.3)
1. Go to Settings (`Ctrl+Alt+S` on Windows)
2. Go to `Languages and Frameworks`, `Schemas and DTDs`, `JSON Schema Mappings`
3. Add a new mapping with the `+` button on the left
4. Under `Schema file or URL`, either select the schema file if you have it saved locally or enter `https://xdplugins.pabloklaschka.de/xsd/xd-manifest.json`
5. Under `Schema version`, select `JSON schema version 7`
6. Below, click the `+` button (to add a mapping) and choose `Add file path pattern`
7. As a pattern, enter `manifest.json` and you should be good to go. Alternatively, you can also use `Add file` and select your manifest file manually...
#### VSCode
1. Go to Settings (`Cmd+,`)
2. Search for `json.schema`
3. Click on `Edit in settings.json`
4. Paste this config
```json
"json.schemas": [
{
"fileMatch": [
"/Adobe/*/develop/*/manifest.json"
],
"url": "https://xdplugins.pabloklaschka.de/xsd/xd-manifest.json"
}
]
```
**Note:** The pattern in `fileMatch` should specifically target the `manifest.json` file inside **your plugin's** folder. (This can be changed to suit your needs)