This plugin allows you to execute scripts as part of your Maven build. It uses the Apache Bean Scripting Framework (BSF) under the hood, so you can use any languages supported by that framework. Support for some languages is in-built. Custom languages (e.g. JRuby) can be added with a couple of XML statements.
You might want to see the list of BSF languages and the list of scripting languages on the JVM.
By default, the following Maven beans are bound as variables for the script:
project artifactMetadataSource artifactResolver artifactFactory localRepository log
Add to the <build><plugins> section of your pom.xml the equivalent of:
<build>
<plugins>
<!-- ... -->
<plugin>
<groupId>com.alexecollins.maven.plugin</groupId>
<artifactId>script-maven-plugin</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>execute</goal>
</goals>
<configuration>
<language>groovy</language>
<script>
System.out.println(project.getName());
</script>
<!-- or..
<scriptFile>script.groovy</scriptFile>
-->
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-bsf</artifactId>
<version>2.4.3</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>To find the latest <version> above, see the script-maven-plugin releases or browse Maven central.
Modify <dependencies> and <configuration> for the chosen scripting language.
If you use <scriptFile>, the language is detected from the filename,
while with the inline <script> you need to
also specify <language>.
<execution>
<phase>package</phase>
<goals><goal>execute</goal></goals>
<configuration>
<!-- beanshell is the default language -->
<script>
System.out.println(project.getName());
</script>
</configuration>
</execution>
...
<dependencies>
<dependency>
<groupId>org.apache-extras.beanshell</groupId>
<artifactId>bsh</artifactId>
<version>2.0b6</version>
<scope>provided</scope>
</dependency>
</dependencies> <executions>
<execution>
<phase>package</phase>
<goals><goal>execute</goal></goals>
<configuration>
<!-- language auto-detected -->
<scriptFile>script.groovy</scriptFile>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-bsf</artifactId>
<version>2.4.3</version>
</dependency>
</dependencies> <executions>
<execution>
<phase>package</phase>
<goals><goal>execute</goal></goals>
<configuration>
<language>ruby</language>
<scriptFile>script.rb</scriptFile>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.jruby</groupId>
<artifactId>jruby</artifactId>
<version>1.7.9</version>
</dependency>
</dependencies>This example also includes an additional dependency.
<executions>
<execution>
<phase>package</phase>
<goals><goal>execute</goal></goals>
<configuration>
<language>javascript</language>
<script>
importPackage(java.lang);
importPackage(org.apache.commons.io);
importPackage(java.io);
System.out.println(project.getName());
FileUtils.touch(new File("marker"));
</script>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mozilla</groupId>
<artifactId>rhino</artifactId>
<version>1.7R5</version>
</dependency>
<!-- additional import for doing file I/O -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.4</version>
</dependency>
</dependencies>You might wish to list the beans available:
mvn script:list-beans
You can do some funky stuff with the beans:
importPackage(java.lang);
importPackage(java.io);
System.out.println(project.getName());
var a = artifactFactory.createArtifact("commons-io", "commons-io", "2.4", "compile", "jar");
artifactResolver.resolve(a, project.getRemoteArtifactRepositories(), localRepository);
System.out.println("locally at " + a.getFile());
System.out.println("versions " + artifactMetadataSource.retrieveAvailableVersions(a, localRepository, project.getRemoteArtifactRepositories()));- It'd be better to use JSR-223, but I need to find a reliable framework first!
Language Engine File Extensions Activity/Popularity
--- --- --- ---
javascript org.apache.bsf.engines.javascript.JavaScriptEngine js High/High
jacl org.apache.bsf.engines.jacl.JaclEngine jacl,tcl High/Low
netrexx org.apache.bsf.engines.netrexx.NetRexxEngine nrx Med/Low
groovy org.codehaus.groovy.bsf.GroovyEngine groovy High/High
scala com.alexecollins.maven.plugin.ScalaEnginge scala High/High
java org.apache.bsf.engines.java.JavaEngine java High/High
javaclass org.apache.bsf.engines.javaclass.JavaClassEngine class High/High
bml org.apache.bml.ext.BMLEngine bml Low/Low
vbscript org.apache.bsf.engines.activescript.ActiveScriptEngine vbs High/Low
jscript org.apache.bsf.engines.activescript.ActiveScriptEngine jss "
perlscript org.apache.bsf.engines.activescript.ActiveScriptEngine pls "
perl org.apache.bsf.engines.perl.PerlEngine pl High/Low
jpython org.apache.bsf.engines.jpython.JPythonEngine py High/Med
jython org.apache.bsf.engines.jython.JythonEngine py High/Med
lotusscript org.apache.bsf.engines.lotusscript.LsEngine lss Low/Low
xslt org.apache.bsf.engines.xslt.XSLTEngine xslt High/High
pnuts pnuts.ext.PnutsBSFEngine pnut Low/Low
beanbasic org.apache.bsf.engines.beanbasic.BeanBasicEngine bb Low/Low
beanshell bsh.util.BeanShellBSFEngine bsh High/Med
ruby org.jruby.javasupport.bsf.JRubyEngine rb High/Med
judoscript com.judoscript.BSFJudoEngine judo,jud Low/Low
† Activity of the Language
- High - release in last 12 months AND active website
- Med - no stable release XOR no active website
- Low - no recent releases AND no active website
‡ Popularity on the Java Platform
- Guess work!