Repository navigation
feat: Extension gallery infrastructure + V2 schema #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
1f96921
push
niels9001 6a0c455
feat: update extension schema to V2 format
niels9001 8d32c02
fix: handle multiline file list in PR validation workflow
niels9001 37c6c18
Update docs/CONTRIBUTING.md
niels9001 e35b7f9
docs: add examples annotations to extension schema
niels9001 71ac314
refactor: remove category field from extension schema
niels9001 cc80d4b
Update extensions/sample-extension/extension.json
niels9001 6580f4f
docs: align url install source description with schema
niels9001 0c1d78b
feat: namespace extensions under author folders to prevent name squat…
niels9001 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,116 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "$id": "https://raw.githubusercontent.com/microsoft/CmdPal-Extensions/main/.github/schemas/extension.schema.json", | ||
| "title": "Command Palette Extension", | ||
| "description": "Schema for a Command Palette extension submission.", | ||
| "type": "object", | ||
| "required": ["id", "title", "description", "author", "icon", "installSources"], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "$schema": { | ||
| "type": "string", | ||
| "description": "Reference to this schema file." | ||
| }, | ||
| "id": { | ||
| "type": "string", | ||
| "description": "Unique extension identifier in author.extension-name format. Must match the folder path (author/extension-name).", | ||
| "pattern": "^[a-z0-9]+(-[a-z0-9]+)*\\.[a-z0-9]+(-[a-z0-9]+)*$", | ||
| "examples": ["jiripolasek.media-controls", "microsoft.sample-extension"] | ||
| }, | ||
| "title": { | ||
| "type": "string", | ||
| "description": "Human-readable display name for the extension.", | ||
| "minLength": 1, | ||
| "maxLength": 100, | ||
| "examples": ["Media Controls for Command Palette", "Quick Notes", "Clipboard Manager"] | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "Short description of the extension.", | ||
| "minLength": 1, | ||
| "maxLength": 200, | ||
| "examples": ["Manage audio or video playback and switch between media apps directly from Command Palette."] | ||
| }, | ||
| "author": { | ||
| "type": "object", | ||
| "description": "Extension author information.", | ||
| "required": ["name"], | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "Author display name.", | ||
| "minLength": 1, | ||
| "maxLength": 100, | ||
| "examples": ["Jiri Polasek", "Microsoft"] | ||
| }, | ||
| "url": { | ||
| "type": "string", | ||
| "description": "URL to the author's website or profile.", | ||
| "format": "uri", | ||
| "examples": ["https://jiripolasek.com", "https://github.com/microsoft"] | ||
| } | ||
| } | ||
| }, | ||
| "icon": { | ||
| "type": "string", | ||
| "description": "Filename of the icon in the same folder. Must be a .png or .svg file.", | ||
| "pattern": "^[\\w.-]+\\.(png|svg)$", | ||
| "examples": ["icon.png", "icon.svg"] | ||
| }, | ||
| "homepage": { | ||
| "type": "string", | ||
| "description": "URL to the project homepage or repository.", | ||
| "format": "uri", | ||
| "examples": ["https://github.com/jiripolasek/MediaControlsExtension"] | ||
| }, | ||
| "tags": { | ||
| "type": "array", | ||
| "description": "Optional freeform tags for filtering. Maximum 5 tags.", | ||
| "items": { | ||
| "type": "string", | ||
| "minLength": 1, | ||
| "maxLength": 30 | ||
| }, | ||
| "maxItems": 5, | ||
| "uniqueItems": true, | ||
| "examples": [["media", "playback", "audio"]] | ||
| }, | ||
| "installSources": { | ||
| "type": "array", | ||
| "description": "One or more installation sources for this extension.", | ||
| "minItems": 1, | ||
| "items": { | ||
| "type": "object", | ||
| "description": "An installation source.", | ||
| "required": ["type"], | ||
| "oneOf": [ | ||
| { | ||
| "properties": { | ||
| "type": { "const": "winget" }, | ||
| "id": { "type": "string", "description": "Winget package identifier.", "minLength": 1, "examples": ["JiriPolasek.MediaControlsforCommandPalette"] } | ||
| }, | ||
| "required": ["type", "id"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "properties": { | ||
| "type": { "const": "msstore" }, | ||
| "id": { "type": "string", "description": "Microsoft Store product ID.", "minLength": 1, "examples": ["9n3bq81g19k7"] } | ||
| }, | ||
| "required": ["type", "id"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "properties": { | ||
| "type": { "const": "url" }, | ||
| "uri": { "type": "string", "description": "Direct download or release page URL.", "format": "uri", "examples": ["https://github.com/jiripolasek/MediaControlsExtension/releases"] } | ||
| }, | ||
| "required": ["type", "uri"], | ||
| "additionalProperties": false | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can an extension have multiple install sources? like, from the store INCLUSIVE_OR from winget?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking we could let the user choose.. but maybe it's overkill? thoughts?