-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
185 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "json.schemas": [ | ||
| { | ||
| "fileMatch": [ | ||
| "changelog.json" | ||
| ], | ||
| "url": "./types/changelog.schema.json" | ||
| }, | ||
| { | ||
| "fileMatch": [ | ||
| "plugins.json" | ||
| ], | ||
| "url": "./types/plugins.schema.json" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "$id": "changelog.schema", | ||
| "title": "Changelog", | ||
| "description": "A plugin changelog. Make sure to add new versions at the bottom of the document!", | ||
| "type": "object", | ||
| "propertyNames": { | ||
| "pattern": "^\\d+.\\d+.\\d+$" | ||
| }, | ||
| "additionalProperties": { | ||
| "type": "object", | ||
| "required": ["title", "author", "date", "categories"], | ||
| "properties": { | ||
| "title": {"type": "string"}, | ||
| "date": {"type": "string", "description": "Date as YYYY/MM/DD", "pattern": "^\\d{4}-\\d{2}-\\d{2}$"}, | ||
| "author": {"type": "string"}, | ||
| "categories": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "title": {"type": "string"}, | ||
| "list": { | ||
| "type": "array", | ||
| "items": {"type": "string"} | ||
| } | ||
| }, | ||
| "defaultSnippets": [ | ||
| { | ||
| "label": "Category", | ||
| "description": "A new category or changes", | ||
| "body": { | ||
| "title": "Changes", | ||
| "list": [ | ||
| "" | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "defaultSnippets": [ | ||
| { | ||
| "label": "New Version", | ||
| "description": "A new version example snippet", | ||
| "body": { | ||
| "title": "1.0.0", | ||
| "author": "", | ||
| "date": "2017-05-07", | ||
| "categories": [ | ||
| { | ||
| "title": "Features", | ||
| "list": [ | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| "title": "Fixes", | ||
| "list": [ | ||
| "" | ||
| ] | ||
| } | ||
| ] | ||
|
|
||
| } | ||
| } | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "$id": "plugins.schema", | ||
| "title": "plugins.json", | ||
| "description": "List of all plugins and their store metadata", | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "object", | ||
| "required": ["title", "author", "version", "icon"], | ||
| "properties": { | ||
| "title": { | ||
| "type": "string", | ||
| "description": "Name of the plugin" | ||
| }, | ||
| "author": { | ||
| "type": "string", | ||
| "description": "Author or authors" | ||
| }, | ||
| "icon": { | ||
| "type": "string", | ||
| "description": "Icon, either an icon resolvable string, or icon.png / icon.svg in the new repo format" | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "Short plugin description" | ||
| }, | ||
| "tags": { | ||
| "type": "array", | ||
| "items": {"type": "string"}, | ||
| "description": "Tags to help categorize the plugin", | ||
| "maxItems": 3 | ||
| }, | ||
| "version": { | ||
| "type": "string", | ||
| "description": "Semver version string" | ||
| }, | ||
| "min_version": { | ||
| "type": "string", | ||
| "description": "Minimum required Blockbench version to run this plugin" | ||
| }, | ||
| "variant": { | ||
| "type": "string", | ||
| "enum": ["both", "desktop", "web"], | ||
| "description": "Specify if Blockbench can run only on desktop, only in the web app, or on both" | ||
| }, | ||
| "creation_date": { | ||
| "type": "string", | ||
| "description": "Date of when the plugin was first released. As YYYY/MM/DD", | ||
| "pattern": "^\\d{4}-\\d{2}-\\d{2}$" | ||
| }, | ||
| "new_repository_format": { | ||
| "type": "boolean", | ||
| "deprecated": true, | ||
| "description": "Instruct the plugin to use the new repository format, see README.md. This field was only used in the transition period, instead the behavior is now based on a min_version of 4.8.0 or higher." | ||
| }, | ||
| "has_changelog": { | ||
| "type": "boolean", | ||
| "description": "Whether the plugin has a changelog.json file, specifying changes in past updates." | ||
| }, | ||
| "await_loading": { | ||
| "type": "boolean", | ||
| "description": "Set to true if you need the plugin to finish loading when starting Blockbench before loading files" | ||
| }, | ||
| "contributes": { | ||
| "type": "object", | ||
| "properties": { | ||
| "formats": { | ||
| "type": "array", | ||
| "items": {"type": "string"} | ||
| } | ||
| } | ||
| }, | ||
| "website": { | ||
| "type": "string", | ||
| "description": "Link to the plugins website", | ||
| "pattern": "^https://.+" | ||
| } | ||
| }, | ||
| "defaultSnippets": [ | ||
| { | ||
| "label": "Basic plugin", | ||
| "description": "A new plugin example", | ||
| "body": { | ||
| "title": "My Plugin", | ||
| "author": "Benchbot", | ||
| "description": "", | ||
| "icon": "icon.png", | ||
| "version": "1.0.0", | ||
| "min_version": "4.10.0", | ||
| "variant": "both" | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "propertyNames": { | ||
| "pattern": "^[a-z0-9_]{3,64}$" | ||
| } | ||
| } |