The ST2 Power Tools project consists of a collection of tools designed to make you more productive with your Sencha Touch 2 projects. Currently, this consists of two separate tools: the Sencha Touch 2 Project Generator and a collection of Sencha Touch 2 live templates for the JetBrains family of IDE's.
You can view a full demo of the current version in action: Create a Complete Sencha Touch 2 Application in Just Minutes.
As an important note, you need to properly setup your Mac for Sencha Touch 2 development before using these tools. You can view my complete post on Getting Setup For Sencha Touch 2 Development on Your Mac for more information on how to do this.
The Sencha Touch 2 Project Generator aims to make creating the skeleton project for your next Sencha Touch 2 project a breeze.
The generator is currently Mac only (although it may work on Windows using Cygwin - I haven't tested that yet).
The generator is an interactive Bash script that walks the user through the project creation process.
To get the generator working, you will need to do two things: copy the script and templates onto your machine and update the script to let it know where you templates are.
First, you'll need to put the script somewhere on your machine that is easily accessible from the command line. If you place it within one of the directories currently in your PATH, then you won't have to type in its directory each time. For this example, we'll place it in
/usr/local/bin. This will require that you are an administrator.
Next, you'll need to take care of the templates. When you grabbed the source from Github the generator directory contained the script (
generateSenchaTouch2Project.sh) and a
templates directory. You can place the templates directory wherever you would like, but for the sake of this example, we'll put it in my Documents directory (
/Users/David/Documents). Once I copy this over to the
Documents directory, I'll need to edit the script to tell it where to find the templates. If you open the
generateSenchaTouch2Project.sh file, you will notice a single configuration variable around line 41:
You will need to change this to point to the directory where you just placed your templates. In my case:
Congrats, you are now ready to use the generator.
Using the generator script is simple. First, open a terminal and navigate to the directory where you want to generate a new project. Next, run the script from that location. If you saved it in the recommended location, you can just type this:
If you see the message
The template directory is not valid - it does not contain an index.html and app.js file then you did not properly configure the template directory.
The script itself will guide you through the creation process by asking for three pieces of information:
- Application Name - This is used as the title of your HTML page, and the variable can be configured to be used anywhere within your templates.
- Sencha Touch 2 SDK Relative Path - This is the relative path from the current directory to the Sencha Touch SDK 2 Directory.
After entering these three pieces of information, your project will be generated into the current directory based on the templates from the templates directory. You may also optionally have the generator open a new Terminal window and start monitoring your
scss directory with compass.
To view a full session with the generator, view this Gist.
While the generator ships with a default template, you can alter these templates to include anything that you would like to have. If you examine the templates, you will notice that variables are defined between percent signs. There are currently four variables available to you that you can use within your custom templates:
%SENCHA_TOUCH_RELATIVE_DIRECTORY%- This is the relative path to the Sencha Touch 2 SDK
%SENCHA_TOUCH_RELATIVE_DIRECTORY_SPLIT%- This is the relative path split into its parts (mainly for config.rb)
%APPLICATION_NAME%- The name of the application
%NAMESPACE_NAME%- The namespace defined for the application
The generator will copy over all files in your templates directory as scan each of them for any of these variables.
The Live Templates provided as a part of this tools package makes it extremely easy to add the default boilerplate code for your views, stores, models, and controllers within your Sencha Touch 2 project.
When you download the tools project from Github, you'll have a
liveTemplates/webstorm directory. Inside of this directory is the
Sencha Touch.xml file that contains the live templates. You will need to place this file in your IDE's template directory. This directory can be seen below:
To utilize any of these live templates, press
CMD+J on Mac or
CTRL+J on PC and it will show you all of the available live templates for the current context.
The live templates don't currently exist for Eclipse, but I may include them in the future.
If you discover any bugs or wish to request a feature, please Submit a New Issue on Github.