dysinger / clojure-maven-plugin forked from talios/clojure-maven-plugin

Welcome to the clojure-maven-plugin plugin for Apache Maven 2.

Available goals

• clojure:compile
• clojure:test
• clojure:run
• clojure:repl
• clojure:swank
• clojure:nailgun

Compiling clojure sources

To use this plugin and start compiling clojure code as part of your maven build, add the following:

<plugins>
  <plugin>
    <groupId>com.theoryinpractise</groupId>
    <artifactId>clojure-maven-plugin</artifactId>
    <version>1.1</version>
  </plugin>
</plugins>

Without any additional configuration, the clojure-maven-plugin will compile any namespaces in ./src/main/clojure/.clj and ./src/test/clojure/.clj.

To change, or add additional source directories you can add the following configuration:

<configuration>
  <sourceDirectories>
    <sourceDirectory>src/main/clojure</sourceDirectory>
  </sourceDirectories>
  <testSourceDirectories>
    <testSourceDirectory>src/test/clojure</testSourceDirectory>
  </testSourceDirectories>
</configuration>

The plugin also provides a clojure:run and clojure:test goal, which will run clojure scripts defined by:

<configuration>
  <script>src/test/clojure/com/jobsheet/jetty.clj</script>
  <testScript>src/test/clojure/com/jobsheet/test.clj</testScript>
</configuration>

If you wish to limit or filter out namespaces during your compile, simply add a configuration section:

<configuration>
  <namespaces>
    <namespace>com.foo</namespace>
    <namespace>net.*</namespace>
    <namespace>!testing.*</namespace>
  </namespaces>
</configuration>

The namespace declaration is actually a regex match against discovered namespaces, and can also be prepended with an ! to filter the matching namespace.

Enjoy.

clojure:repl, clojure:swank and clojure:nailgun goals

clojure-maven-plugin supports three goals intended to make it easier to developers to run interactive clojure shells in the context of maven projects. This means that all dependencies in a project's runtime and test scopes will be automatically added to the classpath and available for experimentation.

Dependencies

In order to run clojure:repl, clojure:swank or clojure:nailgun, your project needs to have a recent (1.0 or later) version of clojure as a dependency in pom.xml.

JLine

If JLine is detected in the classpath, it will be used to provide the clojure:repl goal with history, tab completion, etc. A simple way of enabling this is to put the following in your pom.xml:

    <dependency>
       <groupId>jline</groupId>
       <artifactId>jline</artifactId>
       <version>0.9.94</version>
    </dependency>

Swank

The clojure:swank goal requires a recent version of swank-clojure as a dependency. Unfortunatly, this library is currently not available in the central maven repository, and has to be downloaded and installed manually:

1. Download http://cloud.github.com/downloads/jochu/swank-clojure/swank-clojure-1.0-SNAPSHOT-distribution.zip
2. Unzip the distribution and extract the swank-clojure-1.0-SNAPSHOT.jar file within.

3. Run the following command to install the jar file to your local repository:

   mvn install:install-file -DgroupId=com.codestuffs.clojure -DartifactId=swank-clojure -Dversion=1.0-SNAPSHOT -Dpackaging=jar -Dfile=/path/to/jarfile
   

4. Put the following in your pom.xml

   <dependency>
   <groupId>com.codestuffs.clojure</groupId>
   <artifactId>swank-clojure</artifactId>
   <version>1.0-SNAPSHOT</version>
   </dependency>
   

Nailgun

The clojure:nailgun goal requires a recent version of vimclojure as a dependency. Unfortunatly, this library is currently not available in the central maven repository, and has to be downloaded and installed manually:

1. Download vimclojure source code from http://cloud.github.com/downloads/jochu/swank-clojure/swank-clojure-1.0-SNAPSHOT-distribution.zip.
2. Follow the README to compile and install vimclojure.

3. Locate vimclojure.jar and run the following command to install it to your local repository (replace X.X.X with your version of vimclojure):

   mvn install:install-file -DgroupId=de.kotka -DartifactId=vimclojure -Dversion=X.X.X -Dpackaging=jar -Dfile=/path/to/jarfile
   

4. Put the following in your pom.xml (replace X.X.X with your version of vimclojure)

   <dependency>
   <groupId>de.kotka</groupId>
   <artifactId>vimclojure</artifactId>
   <version>X.X.X</version>
   </dependency>
   

Configuration

The following options that can be configured as system properties:

Support

Join the discussion mailing list at:

http://groups.google.com/group/clojure-maven-plugin