diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index cbb5259507..3ad66ffdba 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1 +1,29 @@ -# PRs for new plugins +# Adding a VS Code extension to Che +Che uses a similar system to OpenVSX when it comes to adding VS Code extensions. In the root of this repository is a [`vscode-extensions.json`](./vscode-extensions.json) file. In order to add/update a VS Code extension in Che, simply add/edit this file with the relevant extension information. + +Here is the expected format of an [`vscode-extensions.json`](./vscode-extensions.json) entry: + +```js + { + // Repository URL to clone and publish from + "repository": "https://github.com/redhat-developer/vscode-yaml", + // Tag or SHA1 ID of the upstream repository that hosts the extension, usually corresponding to a version/snapshot/release. + "revision": "0.8.0" + }, +``` + +Here are all the supported values, including optional ones: + +```js + { + // (OPTIONAL) The subfolder where the code to build the VS Code extension is located, in the event it's not located at the repository root. + "directory": "extension/vscode-yaml/", + // Repository URL to clone and publish from + "repository": "https://github.com/redhat-developer/vscode-yaml", + // Tag or SHA1 ID of the upstream repository that hosts the extension, usually corresponding to a version/snapshot/release. + "revision": "0.8.0" + }, +``` +The file is sorted alphabetically A - Z, based on the repository name (i.e. `vscode-yaml`). + +Automation is in progress to automate the testing and validation of extensions in this JSON file. Stay tuned for more updates as this work is ongoing. \ No newline at end of file diff --git a/vscode-extensions.json b/vscode-extensions.json new file mode 100644 index 0000000000..facb8ea454 --- /dev/null +++ b/vscode-extensions.json @@ -0,0 +1,152 @@ +{ + "extensions": [ + { + "repository": "https://github.com/asciidoctor/asciidoctor-vscode", + "revision": "v2.7.7" + }, + { + "repository": "https://github.com/camel-tooling/camel-lsp-client-vscode", + "revision": "0.0.24" + }, + { + "repository": "https://github.com/eclipse/che-che4z-explorer-for-endevor", + "revision": "0.9.1" + }, + { + "directory": "clients/cobol-lsp-vscode-extension/", + "repository": "https://github.com/eclipse/che-che4z-lsp-for-cobol", + "revision": "0.11.1" + }, + { + "directory": "clients/vscode-hlasmplugin/", + "repository": "https://github.com/eclipse/che-che4z-lsp-for-hlasm", + "revision": "0.11.0" + }, + { + "repository": "https://github.com/cdr/code-server", + "revision": "2.1650-vsc1.39.2" + }, + { + "repository": "https://github.com/fabric8-analytics/fabric8-analytics-vscode-extension", + "revision": "0.0.13" + }, + { + "repository": "https://github.com/scalameta/metals-vscode", + "revision": "v1.9.0" + }, + { + "repository": "https://github.com/MicroShed/mp-starter-vscode-ext", + "revision": "0.2.0" + }, + { + "repository": "https://github.com/redhat-developer/netcoredbg-theia-plugin", + "revision": "v0.0.3" + }, + { + "repository": "https://github.com/redhat-developer/omnisharp-theia-plugin", + "revision": "v0.0.6" + }, + { + "repository": "https://github.com/windup/rhamt-vscode-extension", + "revision": "ca5adb5786114250fb9d4cebe6a327fd8d4d793c" + }, + { + "repository": "https://github.com/VSCodeVim/Vim", + "revision": "v1.14.5" + }, + { + "repository": "https://github.com/camel-tooling/vscode-camelk", + "revision": "0.0.14" + }, + { + "repository": "https://github.com/spgennard/vscode_cobol", + "revision": "6.0.19" + }, + { + "repository": "https://github.com/SebastianZaha/vscode-emacs-friendly", + "revision": "660a6102103745f8e9e5affaa06a29e73ce9065e" + }, + { + "repository": "https://github.com/zowe/vscode-extension-for-zowe", + "revision": "v1.5.1" + }, + { + "repository": "https://github.com/eamodio/vscode-gitlens", + "revision": "v10.2.1" + }, + { + "repository": "https://github.com/golang/vscode-go", + "revision": "0.14.4" + }, + { + "repository": "https://github.com/bmewburn/vscode-intelephense", + "revision": "v1.3.11" + }, + { + "repository": "https://github.com/redhat-developer/vscode-java", + "revision": "v0.63.0" + }, + { + "repository": "https://github.com/Azure/vscode-kubernetes-tools", + "revision": "1.2.0" + }, + { + "repository": "https://github.com/pizzafactory-contorno/vscode-libra-move", + "revision": "v0.0.10-ddc0d3d" + }, + { + "repository": "https://github.com/Microsoft/vscode-node-debug2", + "revision": "v1.42.3" + }, + { + "repository": "https://github.com/redhat-developer/vscode-openshift-tools", + "revision": "v0.1.5" + }, + { + "repository": "https://github.com/felixfbecker/vscode-php-debug", + "revision": "v1.13.0" + }, + { + "repository": "https://github.com/redhat-developer/vscode-project-initializer", + "revision": "v0.0.10" + }, + { + "repository": "https://github.com/microsoft/vscode-pull-request-github", + "revision": "v0.8.0" + }, + { + "repository": "https://github.com/Microsoft/vscode-python", + "revision": "2019.5.18875" + }, + { + "repository": "https://github.com/redhat-developer/vscode-quarkus", + "revision": "v1.3.0" + }, + { + "repository": "https://github.com/testthedocs/vscode-vale", + "revision": "0.9.1" + }, + { + "repository": "https://github.com/camel-tooling/vscode-wsdl2rest", + "revision": "0.0.11" + }, + { + "repository": "https://github.com/redhat-developer/vscode-xml", + "revision": "0.11.0" + }, + { + "repository": "https://github.com/redhat-developer/vscode-yaml", + "revision": "0.8.0" + }, + { + "directory": "xtend-vscode-extension/", + "repository": "https://github.com/PizzaFactory/xtend-ide-extensions", + "revision": "v0.1.0" + }, + { + "directory": "xtext-vscode-extension/", + "repository": "https://github.com/PizzaFactory/xtext-ide-extensions/", + "revision": "v0.4.0" + } + ] +}