QtCreator-JsExtensions-Plugin

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

QtCreator-JsExtensions-Plugin

★ 23 Open GitHub ↗

QtCreator plugin which enables writting plugins in JS/QML

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#JsExtensions Plugin
This QtCreator plugin enables writing plugins using JavaScript/QML
#Overview
Plugin allows to easily write simple additions to QtCreator called JEP plugins (*.jep.js files).
JEP plugin files are JavaScript files with most of the QtCreator API avaliable.
You don't need to clone and build QtCreator to develop QtCreator plugins.

You can get a pre-compiled plugin for Linux(Ubuntu) and Windows [here](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/releases). Just unzip JsExtensions folder to the QtCreator plugins folder (you may need to change the version of dependency Core in JsExtensions.pluginspec file - valid range from 3.0.0 to 3.2.1).

Here are some screenshots of JEP plugin:

![Demo_screenshot_linux](https://raw.githubusercontent.com/lexxmark/QtCreator-JsExtensions-Plugin/master/img/DemoLinux.png)
![Demo_screenshot_windows](https://raw.githubusercontent.com/lexxmark/QtCreator-JsExtensions-Plugin/master/img/DemoWin.png)

Video available [here](http://youtu.be/SQAcvXjmXzA).

There are 5 JEP-Plugins available now. You can manage them via Tools->JsExtensions... menu in QtCreator:

1. [RelaxTracker](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/tree/master/jep_plugins/RelaxTracker) is a green box with "Work" label on Mode panel. This is a QQuickView window which periodically flashes with a red box and a label "Break"  - to remind user to have a break.
2. [ModePanelButtons](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/tree/master/jep_plugins/ModePanelButtons) places your favorite commands as buttons on Mode panel.
3. [Calculator](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/tree/master/jep_plugins/Calculator) QML based calculator widget from QtCreator examples, which can be shown in Navigation panel (see video).
4. [Jenkins](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/tree/master/jep_plugins/Jenkins) shows status of buildson Jenkins server.
5. Weather-box shows current weather conditions [see](https://github.com/lexxmark/QtCreator-JsExtensions-Plugin/tree/master/pluginshondin/Weather).

#How to write JEP plugins
At QtCreator startup JsExtensions plugin scans jep_plugins folder and subfolders for *.jep.js files. It tries to load each *.jep.js file, looks for "initialize" function inside and executes it. We can write minimal jep plugin like this:

```JavaScript
function initialize() {
    // write message to General Messages panel with flashing
    messageManager.write("Jep plugin has started!", 512);
}
```

There are two optional functions **extensionsInitialized()** and **aboutToShutdown()** that will be called in **JsExtensionsPlugin::extensionsInitialized** and **JsExtensionsPlugin::aboutToShutdown** functions. Also there are four optional variables to manage JEP plugins:

1. **pluginDescription** - short text description of the plugin (for example "var pluginDescription = "My very usefull plugin";")
1. **pluginPriority** - numeric variable to change loading order (for example "var pluginPriority = 1;")
2. **pluginEnable** - bool variable to abort plugin loading (for example "var pluginEnable = false;")
3. **pluginTrace** - bool variable to trace all wrapper calls to log file (for example "var pluginTrace = true;")

In the global object of the JavaScript/QML environment were injected several objects to access QtCreator API:

1. **core** - wraps Core::ICore
2. **messageManager** - wraps Core::MessageManager
3. **actionManager** - wraps Core::ActionManager
5. **modeManager** - wraps Core::ModeManager
6. **jepAPI** - collection of utility functions

In addition to singleton objects there are wrappers for some other classes:

1. Core::ActionContainer
2. Core::Command

QtCreator-JsExtensions-Plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README