eclipse-theia / generator-theia-extension

A Yeoman generator for extensions to the Theia IDE
Other
49 stars 37 forks source link
theia-extension theia-ide yeoman

theia logo

ECLIPSE THEIA - EXTENSION GENERATOR

[![Build](https://github.com/theia-ide/generator-theia-extension/workflows/Build/badge.svg?branch=master)](https://github.com/theia-ide/generator-theia-extension/actions?query=branch%3Amaster) ![npm](https://img.shields.io/npm/v/generator-theia-extension?color=blue)
A [yeoman](https://yeoman.io/) generator that scaffolds a project structure for developing [Eclipse Theia](https://github.com/eclipse-theia/theia) extensions.

How to use

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 project with a Theia extension including a browser and electron app, run:

mkdir my-extension && cd my-extension
yo theia-extension

For configuration options, see:

yo theia-extension --help

Extension Options

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

Publishing

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

License

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia