Javascript – How to compress JS and css in java at build time using maven-minify-plugin with YUI compressor

javajavascriptmaven-2minifyyui

I want to use maven-minify plugin with YUI compressor for compressing JS and css at build time.
My JS and CSS are kept in different folders. For instance. 'X' JS files are present in one folder and remaining are present in different folder. Same is the case with CSS files.

Also I want to know, how does reference of JS and CSS gets changed in JSP,if in case the file name changes from jsFileName.js to something like jsFileName-min.js

Please let me know how to use this plugin as I am completely new to this.

Best Answer

Use Samaxes plug-in, configure like this:

<plugin>
    <groupId>com.samaxes.maven</groupId>
    <artifactId>maven-minify-plugin</artifactId>
    <version>1.3.5</version>
    <executions>
        <execution>
            <id>min-js</id>
            <phase>process-resources</phase>
            <configuration>
                <cssSourceDir>relative/path/to/css/dir</cssSourceDir>
                <cssSourceFiles>
                    <cssSourceFile>subfolder1/1.css</cssSourceFile>
                    <cssSourceFile>subfolder1/3.css</cssSourceFile>
                    <cssSourceFile>subfolder2/2.css</cssSourceFile>
                </cssSourceFiles>
                <cssTargetDir>relative/path/to/final/location</cssTargetDir>
                <cssFinalFile>minified.css</cssFinalFile>

                <jsSourceDir>relative/path/to/js/dir</jsSourceDir>
                <jsSourceFiles>
                    <jsSourceFile>subfolder3/1.js</jsSourceFile>
                    <jsSourceFile>subfolder4/2.js</jsSourceFile>
                </jsSourceFiles>
                <jsFinalFile>minifiedname.js</jsFinalFile>
                <jsTargetDir>rel/path/to/final/location</jsTargetDir>
            </configuration>
            <goals>
                <goal>minify</goal>
            </goals>
        </execution>
        <!-- more execution statements -->
    </executions>                               
</plugin>

Related Solutions

Java – How to create an executable JAR with dependencies using Maven

<build>
  <plugins>
    <plugin>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <archive>
          <manifest>
            <mainClass>fully.qualified.MainClass</mainClass>
          </manifest>
        </archive>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
      </configuration>
    </plugin>
  </plugins>
</build>

and you run it with

mvn clean compile assembly:single

Compile goal should be added before assembly:single or otherwise the code on your own project is not included.

See more details in comments.

Commonly this goal is tied to a build phase to execute automatically. This ensures the JAR is built when executing mvn install or performing a deployment/release.

<plugin>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <archive>
      <manifest>
        <mainClass>fully.qualified.MainClass</mainClass>
      </manifest>
    </archive>
    <descriptorRefs>
      <descriptorRef>jar-with-dependencies</descriptorRef>
    </descriptorRefs>
  </configuration>
  <executions>
    <execution>
      <id>make-assembly</id> <!-- this is used for inheritance merges -->
      <phase>package</phase> <!-- bind to the packaging phase -->
      <goals>
        <goal>single</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Javascript – YUI Compressor Maven plugin executed at wrong time and tomcat plugin not using yui-compressor output

I faced a similar issue and I changed my phase to package. Hopefully this will help someone else as well.

This is tricky. This has to do with the nosuffix config option. If you remove the nosuffix option, the minification works as expected.

If you really have to have nosuffix then you need to change the execution phase to "package".

    <executions>
      <execution>
        <phase>package</phase>
          <goals>
    ......
    .....

Any phase before prepare-resources doesn't work because when the war is built, it picks up the js from the original source location and thereby overwrites the minified js (created during prepare-resources phase) in the target directory.

Minification works when you remove nosuffix because during package phase, the file names are different, so there is no over-writing of the files and you will see both the minified and non-minified js files in your target directory.

Best Answer

Related Solutions

Java – How to create an executable JAR with dependencies using Maven

Javascript – YUI Compressor Maven plugin executed at wrong time and tomcat plugin not using yui-compressor output

Related Topic