A yeoman generator that scaffolds a project structure for developing custom Eclipse Theia applications and extensions.
Please also see:
To use it, install yo
(version 4.x.x) and the generator
(see next below).
npm install -g yo generator-theia-extension
To create a sample Theia project (optionally with custom Theia extensions) including a browser and electron app, run:
mkdir my-theia-app && cd my-theia-app
yo theia-extension
For configuration options, see:
yo theia-extension --help
The generator allows to generate an example extension that is directly part of the generated Theia application. Alternativly, you can select 'no-extension' to just generate a Theia application without a custom extension.
Template Option | Description | Documentation |
---|---|---|
hello-world |
Creates a simple extension which provides a command and menu item which displays a message | readme |
widget |
Creates the basis for a simple widget including a toggle command, alert message and button displaying a message. The template also contains an example unit test. | readme |
labelprovider |
Creates a simple extension which adds a custom label (with icon) for .my files | readme |
tree-editor |
Creates a tree editor extension | readme |
empty |
Creates a simple, minimal extension | readme |
backend |
Creates a backend communication extension | readme |
diagram-editor |
Creates a diagram editor extension | readme |
no-extension |
Creates a Theia application without any extension |
Follow this instruction to login to the npm registry with a user account.
If you don't have an account contact Theia organization to request one.
Publish with np.
npx np
- Eclipse Public License 2.0
- 一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception
"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia