generator-mendix

generator-mendix

Yeoman generator for Mendix widgets.

About

This generator uses the Yeoman scaffolding tool to let you quickly create a Mendix widget based on the latest AppStoreWidgetBoilerPlate.

Prerequisites

First, you need to have NodeJs installed. After that, you need to install Yeoman, Mendix Widget generator and Grunt:

npm install -g yo generator-mendix grunt-cli

Usage

1.) Start the generator in the folder you want to create a widget:

yo mendix

2.) The generator will ask you to provide the following information about your widget:

• name
• description
• copyright
• license
• version
• author
• Github username (optional)

3.) Your widget will be created using the options and the boilerplate.

It will clone the boilerplate, rename your widget according to the options. It also includes a Gruntfile.js and package.json for development purposes (see below)

Grunt

The generator will include Grunt to automate your widget development. Make sure you have Grunt installed.

The following Grunt tasks are available:

• grunt start-modeler

This will try to open the Modeler using the included test-project. (Older versions of the Gruntfile will use grunt start-mendix)

• grunt watch (this is actually an alias for default, so you can run grunt without adding this taskname)

This watches for changes in your src folder. When a file is changed, it copies the change to the deployment-folder (so you do not have to restart your project when changing files (with the exception of .xml files)). It also automatically creates a .mpk file in your /dist and test/widgets folder.

• grunt version

This will let you set the version of your widget, the package.xml, without editing it yourself.

• grunt build

Cleans old .mpk files and creates a new one in your /dist and test/widgets folder

Grunt can be started from command-line, or used by Grunt-plugins for different IDE's:

• WebStorm
• Brackets
• Visual Studio Code (has built-in support for Grunt & Gulp)
• Sublime Text
• NetBeans (has built-in support for Grunt)

TODO:

• Gulp integration
• Add JSHint (Grunt/Gulp)
• Move package.json & Gruntfile.js to Boilerplate

Issues

Issues can be reported on Github.