pl.allegro.tdr.gruntmaven.ExecGruntMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grunt-maven-plugin Show documentation
Integrates GruntJS with Maven build.
There is a newer version: 1.5.1
/*
 * Copyright 2013 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package pl.allegro.tdr.gruntmaven;

import java.util.ArrayList;
import java.util.List;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import static org.twdata.maven.mojoexecutor.MojoExecutor.*;

/**
 * Executes grunt.
 *
 * @author Adam Dubiel
 */
@Mojo(name = "grunt", defaultPhase = LifecyclePhase.TEST)
public class ExecGruntMojo extends AbstractExecutableMojo {

    /**
     * Custom success codes to be registered in maven-exec plugin when we want to ignore
     * Grunt errors.
     */
    private static final String[] IGNORE_GRUNT_TASKS_ERRORS_CUSTOM_CODES = {"0", "3", "6"};

    private static final String[] IGNORE_ALL_GRUNT_ERRORS_CUSTOM_CODES = {"0", "1", "2", "3", "4", "5", "6"};

    /**
     * Name of grunt target, will be passed directly to grunt.
     */
    @Parameter(property = "target", defaultValue = "")
    private String target;

    /**
     * Name of node executable in PATH, defaults to node.
     */
    @Parameter(property = "nodeExecutable", defaultValue = "node")
    private String nodeExecutable;

    /**
     * Path to local grunt executable, defaults to grunt (global PATH).
     */
    @Parameter(property = "gruntExecutable", defaultValue = "grunt")
    private String gruntExecutable;

    /**
     * Should grunt be run as node module (ex: node node_modules/grunt-cli/bin/grunt).
     * By default grunt is run as independent command line executable.
     */
    @Parameter(property = "runGruntWithNode", defaultValue = "false")
    private boolean runGruntWithNode;

    /**
     * List of options passed to grunt.
     */
    @Parameter(property = "gruntOptions")
    private String[] gruntOptions;

    /**
     * Should Maven ignore grunt task errors (for example failing tests) and always finish grunt execution with success.
     */
    @Parameter(property = "ignoreTasksErrors", defaultValue = "false")
    private boolean ignoreTasksErrors;

    /**
     * Should Maven ignore all grunt errors including fatal ones and always finish grunt execution with success.
     */
    @Parameter(property = "ignoreAllErrors", defaultValue = "false")
    private boolean ignoreAllErrors;

    @Override
    protected String getExecutable() {
        if (runGruntWithNode) {
            return nodeExecutable;
        }
        return gruntExecutable;
    }

    @Override
    protected Element[] getArguments() {
        List arguments = new ArrayList();

        if (runGruntWithNode) {
            arguments.add(element(name("argument"), gruntExecutable));
        }
        if (target != null && !target.isEmpty()) {
            arguments.add(element(name("argument"), target));
        }
        if (!showColors) {
            arguments.add(element(name("argument"), "--no-color"));
        }
        if (gruntOptions != null) {
            appendOptions(arguments);
        }

        return arguments.toArray(new Element[arguments.size()]);
    }

    private void appendOptions(List arguments) {
        for (String option : gruntOptions) {
            arguments.add(element(name("argument"), normalizeArgument(option, "=")));
        }
    }

    @Override
    protected String[] customSuccessCodes() {
        if (ignoreAllErrors) {
            return IGNORE_ALL_GRUNT_ERRORS_CUSTOM_CODES;
        } else if (ignoreTasksErrors) {
            return IGNORE_GRUNT_TASKS_ERRORS_CUSTOM_CODES;
        }
        return null;
    }

}