Skip to content
El Jaoujat Youssef edited this page Feb 9, 2016 · 24 revisions

Overview

Hybris Impex Editor adds support to Impex language by providing features like:

Ressources

Installation

From eclipse marketplace.

  1. Select Help > Eclipse Marketplace...
  2. In the search box enter the keyword "hybris" and choose hybris Impex editor v1.5.5 and click Install

Using eclispe update site

  1. Select Help > Install New Software...
  2. In the Add Site dialog, enter http://eljoujat.github.io/updates/ , and click OK.
  3. Place a checkmark next to Impex, confirm that the sub-components are all checked, and click Install.

Manual installation

1.Got to https://github.com/eljoujat/eclipseimpexeditor/releases . 2. fetch the latest release jar file . 3 . Put the file into dropins folder and restart eclipse .

Usage

Syntax highlighting

The Syntax highlighting feature uses the rule-based scanner class. The scanner takes a given number of rules, and consumes the Impex file and evaluates each token. If the token matches a rule, the scanner exits with the corresponding properties.

The ruleset is based on the Hybris Impex syntax documentation

Before : Before

After :

After

Autocompletion

The auto-completion is the most liked what the most user look for in any text editor since I have stored the data definition, this feature was easy to implement as well:

Preference Snapshot

Preferences Of the plugins:

I also used the Preferences API to allow customization, to give the more friendly user experience.

It's possible to customize the feel and look of the Impex file:

Preference Snapshot

And you can configure the connection with hybris, to execute and validate the Impex with any running instance of hybris!

Preference Snapshot

Indexing and updating model.

How to build from code source.

This project is built using Eclipse Tycho (https://www.eclipse.org/tycho/) and requires at least maven 3.0 (http://maven.apache.org/download.html) to be built via CLI.

  1. fork the code source git clone https://github.com/eljoujat/eclipseimpexeditor.git
  2. cd eclipseimpexeditor
  3. mvn clean package

The first run will take quite a while since maven will download all the required dependencies in order to build everything.

In order to use the generated eclipse plugins in Eclipse, you will need m2e (https://www.eclipse.org/m2e) and the m2eclipse-tycho plugin (https://github.com/tesla/m2eclipse-tycho/). Update sites to install these plugins :

What next:

Other features I'm working on are:

  • Validate the impex with error markers.
  • Execute the impex .
  • Hyperlink features to easily locate where an Item is already valued from the same impex .
  • Find usage Features, find all usage for the selected defined and selected item.
  • Formatting .

Other existing plugins for Hybris

  1. https://github.com/ShahnazK/hylips (abandoned?)
  2. https://github.com/erikwennerberg/impexPlugin (a little bit better coloring, e.g. semicolon is in different color)
Clone this wiki locally