https://github.com/eclipsesource/theia-tutorial-extension
https://github.com/eclipsesource/theia-tutorial-extension
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/eclipsesource/theia-tutorial-extension
- Owner: eclipsesource
- License: epl-2.0
- Created: 2020-11-18T15:09:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-04-15T11:22:17.000Z (over 4 years ago)
- Last Synced: 2025-03-24T09:52:48.598Z (over 1 year ago)
- Language: TypeScript
- Size: 500 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tutorial extension for Theia and VSCode
The tutorial extension is displaying a tutorial based on a .json file. One tutorial can have multiple exercise-steps. Each exercise can display different content types but also can execute commands in the terminal, add imports and run checks on the progress of the learner. All of that has to be defined in the .json file inside the workspace.
## Feedback, Help and Support
Feel free to start a discussion by opening an issue on this repo or by contacting us [directly via email](mailto:info@eclipsesource.com).
## Developers Documentation
### First time setup
- Install [node.js](https://nodejs.org/) (version >= 6.x.x)
- Update npm (version >= 5.8.0)
- Clone this repository
- Install dependencies: `yarn install`
### Build & Testing
```bash
yarn compile
```
After that press `F5` to run the application.
### Packaging and Publishing
#### Packaging
```bash
npm install -g vsce
vsce package
```
#### Publishing
##### Open VSX
Under [open-vsx.org](https://open-vsx.org/) register with your GitHub account and generate an Access Token.
```bash
npx ovsx create-namespace -p
npx ovsx publish -p
```
Where **name** is the extension's `publisher` field in the package.json file and **file** is the path to the .vsix file generated in the first step.
A detailed description of publishing to Open VSX can be found [here](https://github.com/eclipse/openvsx/wiki/Publishing-Extensions).
##### VS Code Extension Marketplace
Register on [Azure DevOps](https://go.microsoft.com/fwlink/?LinkId=307137) and create a new organization.
On `https://dev.azure.com/{yourorganization}`, open your user settings, then select **Personal access tokens** and create a **New Token** with the following settings:
Copy the Personal acces token to use it with `vsce`
From the root of the repository:
```bash
vsce login
vsce publish
```
Alternatively the `.vsix` file generated with `vsce package` could be uploaded manually to the [Visual Studio Marketplace publisher management page](https://marketplace.visualstudio.com/manage)
More detailed instructions on how to publish the extension on the Visual Studio Marketplace can be found [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)
## License
- [Eclipse Public License 2.0](https://opensource.org/licenses/EPL-2.0)
- [The MIT License](https://opensource.org/licenses/MIT)