liferay-theme-tasks-themelet

Liferay Theme Tasks

The liferay-theme-tasks module is intended for use with the yeoman generator for Liferay themes.

Available tasks

• build
• deploy
• extend
• kickstart
• status
• watch
• init

Build

gulp build

The build task generates the base theme files, compiles sass into css, and zips all theme files into a .war file, ready to be deployed to a Liferay server.

Deploy

gulp deploy

The deploy initially runs the build task, and once the .war file has been created it deploys to the specified local appserver.

If you want to deploy to a live site, use the --live flag to deploy to a remote server.

gulp deploy --live

Note that the specified server must have the server-manager-web plugin deployed. The --live flag will deploy to the remote server specified in the init task.

If you want to deploy to a different server without changing the default server specified in init, you may use the --url flag.

gulp deploy --live --url http://some-host.com

You may also specify your login credentials using the -u/--username and -p/--password flags.

gulp deploy --live -u [e-mail] -p test

Note: the deploy --live task is not currently working for Liferay 7.0 as the server-manager-web plugin has not been migrated to work with OSGi.

Deploy Gogo

For Liferay 7.0 themes, there is an optional deploy command for deploying your theme via OSGi. This task will NOT work for 6.2 themes.

gulp deploy:gogo

Note that Liferay Portal's gogo shell must be running for this command to work.

Extend

gulp extend

The extend task is what allows you to specify what base theme you are extending from. By default, themes created with the theme generator will base off the styled theme.

You first are prompted if you want to extend a Base theme or Themelet, then you will be prompted for where you would like to search for modules. Globally installed npm modules will search npm modules that have been installed on your computer with the -g flag. Selecting npm registry will search for published modules on npm.

Once it gives you the options and you make your selection, it will add any selected modules to your package.json under dependencies and run npm install.

Kickstart

gulp kickstart

The kickstart task allows you to copy the css, images, js, and templates from another theme into the src directory of your own. This allows you to quickly get up and running with a production ready theme.

kickstart is similar to extend. The difference is that kickstarting from another theme is a one time inheritance, while extending from another theme is a dynamic inheritance that applies your src files on top of the base theme on every build.

Status

gulp status

Displays what base theme/themelets your theme is extending.

Watch

gulp watch

The watch task allows you to see the changes you make to your theme without a full redeploy.

After invoking the watch task, every time you save any changes to a file in your theme it compiles (if applicable) and copies it directly to your appserver.

Init

gulp init

Prompts user for local and remote appserver information used for deployment purposes (see deploy task).

API

registerTasks

To register the liferay-theme-tasks you must call the registerTasks method in your theme's gulpfile.js, gulp being the only required parameter.

var gulp = require('gulp');
var liferayThemeTasks = require('liferay-theme-tasks');
 
liferayThemeTasks.registerTasks({
    gulp: gulp
});

Options

distName

type: string
required: false

The name that will be given to the generated war file. The distName can also be a template which has access to the theme's package.json fields.

liferayThemeTasks.registerTasks({
    distName: '${name}-${version}',
    gulp: gulp
});
 
// my-theme-1.0.0

Note: in 7.0 changing the war file name will also affect the context path of the theme when using gulp deploy which can result in having multiple versions of your theme deployed at the same time.

gulp

type: gulp instance
required: true

A gulp instance for exposing liferay-theme-tasks.

hookFn

type: function

Allows theme developers to hook and overwrite tasks/sub tasks.

var gulp = require('gulp');
var liferayThemeTasks = require('liferay-theme-tasks');
 
liferayThemeTasks.registerTasks({
    gulp: gulp,
    hookFn: function(gulp) {
        gulp.hook('before:build:src', function(done) {
            // Fires before build:src task
        });
 
        gulp.hook('after:build', function(done) {
            // Fires after build task
        });
 
        gulp.task('build:base', function(done) {
            // Overwrites build:base task
        });
    }
});

Note: hook callback function must invoke done argument OR return a stream.

pathBuild

type: string
default: ./build

Determines the destination of built files.

pathDist

type: string
default: ./dist

Determines the destination of the generated .war file.

pathSrc

type: string
default: ./src

Determines where theme source files are located. If set to anything other than default value, you must manually relocate all files in src directory to new location.

sassOptions

type: object

Whatever properties are set in sassOptions get passed to either gulp-sass or gulp-ruby-sass depending on what sass compiler is implemented.

liferayTheme

The liferayTheme object is located in a theme's package.json file and contains various options that relate to the gulp tasks.

{
    "name": "my-liferay-theme",
    "version": "1.0.0",
    "main": "package.json",
    "keywords": [
        "liferay-theme"
    ],
    "liferayTheme": {
        "baseTheme": "styled",
        "rubySass": false,
        "templateLanguage": "ftl",
        "version": "7.0"
    },
    "devDependencies": {
        "gulp": "^3.8.10",
        "liferay-theme-deps-7.0": "*",
        "liferay-theme-tasks": "*"
    }
}

baseTheme

Determines the base theme. This property is set by the extend task.

hookModules

The name or names of npm modules. These modules must expose a function that follows the same pattern as a hookFn.

If a module is listed in hookModules, it must also be added to the devDependencies of the theme.

rubySass

If set to true gulp-ruby-sass is used as sass compiler. If set to false gulp-sass is used.

If changing this property from the default value, the appropriate sass compiler will need to be added as a dev dependency of your theme.

For example, if your theme is intended for Liferay Portal 7.0 and you set rubySass to true, you will then need to add gulp-ruby-sass to the devDependencies of your theme and run npm install.

themelets

Determines the themelets that are implemented by this theme. This property is set by the extend task.

version

Version of Liferay Portal this theme is intended for.

Additional Theme Dependencies

In order for themes to successfully build, they must declare additional dependencies in their package.json file.

These additional dependencies are normally included via the liferay-theme-deps-7.0 and liferay-theme-deps-6.2 preset packages which are automatically added as dependencies to themes created with the Theme Generator.

These preset packages will include the necessary base themes/tools for compiling the theme, such as liferay-frontend-theme-unstyled and liferay-frontend-theme-styled.

If you would like to implement specific versions of these dependencies, you can specify them as dependencies directly in your theme's package.json file.

MIT