2010-06-16 01:58:14 +00:00
|
|
|
# Tutorial
|
|
|
|
|
|
|
|
For those of you new to the JVM who have never touched Ant or Maven in
|
|
|
|
anger: don't panic. Leiningen is designed with you in mind. This
|
2010-06-17 04:10:56 +00:00
|
|
|
tutorial will help you get started and explain Leiningen's take on
|
|
|
|
project building and JVM-land dependency management.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## Creating a Project
|
|
|
|
|
|
|
|
We'll assume you've got Leiningen installed as per the
|
2010-12-03 02:16:16 +00:00
|
|
|
[README](https://github.com/technomancy/leiningen/blob/stable/README.md).
|
2010-06-16 01:58:14 +00:00
|
|
|
Generating a new project is easy:
|
|
|
|
|
|
|
|
$ lein new myproject
|
|
|
|
|
|
|
|
Created new project in: myproject
|
|
|
|
|
|
|
|
$ cd myproject
|
|
|
|
$ tree
|
|
|
|
.
|
|
|
|
|-- project.clj
|
|
|
|
|-- README
|
|
|
|
|-- src
|
|
|
|
| `-- myproject
|
|
|
|
| `-- core.clj
|
|
|
|
`-- test
|
|
|
|
`-- myproject
|
2011-05-04 02:42:31 +00:00
|
|
|
`-- test
|
|
|
|
`-- core.clj
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-08-20 03:53:40 +00:00
|
|
|
Here we've got your project's README, a src/ directory containing the
|
|
|
|
code, a test/ directory, and a project.clj file which describes your
|
|
|
|
project to Leiningen. The src/myproject/core.clj file corresponds to
|
|
|
|
the myproject.core namespace.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-08-20 03:53:40 +00:00
|
|
|
Note that we use myproject.core instead of just myproject since
|
2011-05-04 02:42:31 +00:00
|
|
|
single-segment namespaces are discouraged in Clojure. Also if you have
|
|
|
|
namespaces with dashes in the name, the corresponding file will need
|
|
|
|
to use underscores instead since the JVM has trouble loading files
|
|
|
|
with dashes in the name.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## Packaging
|
|
|
|
|
|
|
|
You can package your project up now, even though at this stage it's
|
|
|
|
fairly useless:
|
|
|
|
|
|
|
|
$ lein jar
|
|
|
|
|
2010-06-17 04:10:56 +00:00
|
|
|
Created ~/src/myproject/myproject-1.0.0-SNAPSHOT.jar
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
Libraries for the JVM are packaged up as .jar files, which are
|
2010-06-19 03:56:36 +00:00
|
|
|
basically just .zip files with a little extra JVM-specific metadata.
|
|
|
|
They usually contain .class files (JVM bytecode) and .clj source
|
|
|
|
files, but they can also contain other things like config
|
2011-03-16 01:45:04 +00:00
|
|
|
files. Leiningen downloads jar files of dependencies from remote Maven
|
|
|
|
repositories for you.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## project.clj
|
|
|
|
|
|
|
|
$ cat project.clj
|
|
|
|
|
|
|
|
(defproject myproject "1.0.0-SNAPSHOT"
|
2011-03-16 01:45:04 +00:00
|
|
|
:description "FIXME: write description"
|
2011-02-19 04:43:29 +00:00
|
|
|
:dependencies [[org.clojure/clojure "1.2.0"]])
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
Fill in the :description with a short paragraph so that your project
|
2011-05-04 02:42:31 +00:00
|
|
|
will show up in search results once you publish it. At some point
|
|
|
|
you'll need to flesh out the README too, but for now let's skip ahead
|
|
|
|
to setting :dependencies. Note that Clojure is just another
|
|
|
|
dependency here. Unlike most languages, it's easy to swap out any
|
|
|
|
version of Clojure.
|
2010-06-19 03:56:36 +00:00
|
|
|
|
2010-06-16 01:58:14 +00:00
|
|
|
If you've got a simple pure-clojure project, you will be fine with the
|
2011-02-19 04:43:29 +00:00
|
|
|
default of depending only on Clojure, but otherwise you'll need to
|
|
|
|
list other dependencies.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
[Clojars](http://clojars.org) is the Clojure community's centralized
|
|
|
|
jar repository, and it's where you'll find Clojure dependencies for your
|
|
|
|
project. Each dependency even lists out the snippet you'll need to put
|
2010-06-29 19:58:23 +00:00
|
|
|
in your project.clj to use it. Let's take a look at what it would take
|
2011-03-16 01:45:04 +00:00
|
|
|
to add a library named Lancet:
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
It's [available on Clojars](http://clojars.org/lancet) with the
|
2010-06-29 19:58:23 +00:00
|
|
|
Leiningen dependency notation shown as below:
|
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
[lancet "1.0.0"]
|
2010-06-19 03:56:36 +00:00
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
The "artifact id" here is "lancet", and "1.0.0" is the version you
|
|
|
|
require. Every library also has a "group id", though for Clojure
|
|
|
|
libraries it is often the same as the artifact-id, in which case you
|
|
|
|
may leave it out of the Leiningen dependency notation. For Java
|
2011-05-04 02:42:31 +00:00
|
|
|
libraries often a reversed domain name is used as the group id.
|
2010-06-22 02:21:13 +00:00
|
|
|
|
2011-05-24 05:07:04 +00:00
|
|
|
Most Java libraries can be found by searching
|
|
|
|
[Maven Central](http://search.maven.org), though you'll need to translate the
|
2010-06-29 19:58:23 +00:00
|
|
|
Maven XML notation into
|
2011-05-24 05:07:04 +00:00
|
|
|
Leiningen's. [Lucene](http://search.maven.org/#artifactdetails%7Corg.apache.lucene%7Clucene-core%7C3.0.2%7Cjar)
|
2010-06-29 19:58:23 +00:00
|
|
|
is a typical example:
|
|
|
|
|
|
|
|
<dependency>
|
|
|
|
<groupId>org.apache.lucene</groupId>
|
|
|
|
<artifactId>lucene-core</artifactId>
|
|
|
|
<version>3.0.2</version>
|
|
|
|
</dependency>
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
This becomes:
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
[org.apache.lucene/lucene-core "3.0.2"]
|
2010-06-19 03:56:36 +00:00
|
|
|
|
2010-06-16 01:58:14 +00:00
|
|
|
Sometimes versions will end in "-SNAPSHOT". This means that it is not
|
2010-06-19 03:56:36 +00:00
|
|
|
an official release but a development build. Relying on snapshot
|
|
|
|
dependencies is discouraged but is sometimes necessary if you need bug
|
2010-12-07 18:33:22 +00:00
|
|
|
fixes, etc. that have not made their way into a release yet. However,
|
|
|
|
snapshot versions are not guaranteed to stick around, so it's
|
|
|
|
important that released code never depends upon snapshot versions that
|
|
|
|
you don't control. Adding a snapshot dependency to your project will
|
|
|
|
cause Leiningen to actively go seek out the latest version of the
|
|
|
|
dependency once a day when you run <tt>lein deps</tt>, (whereas normal
|
|
|
|
release versions are cached in the local repository) so if you have a
|
|
|
|
lot of snapshots it will slow things down.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
Speaking of the local repository, all the dependencies you pull in
|
2010-06-19 03:56:36 +00:00
|
|
|
using Leiningen or Maven get cached in $HOME/.m2/repository since
|
|
|
|
Leiningen uses the Maven API under the covers. You can install the
|
|
|
|
current project in the local repository with this command:
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
$ lein install
|
|
|
|
|
|
|
|
Wrote pom.xml
|
2010-06-17 04:10:56 +00:00
|
|
|
[INFO] Installing myproject-1.0.0-SNAPSHOT.jar to ~/.m2/repository/myproject/myproject/1.0.0-SNAPSHOT/myproject-1.0.0-SNAPSHOT.jar
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2011-05-04 02:42:31 +00:00
|
|
|
Note that some libraries make their group-id and artifact-id
|
|
|
|
correspond with the namespace they provide inside the jar, but this is
|
|
|
|
just a convention. There is no guarantee they will match up at all, so
|
|
|
|
consult the library's documentation before writing your :require clauses.
|
|
|
|
|
2010-06-19 03:56:36 +00:00
|
|
|
Generally Leiningen will fetch your dependencies when they're needed,
|
|
|
|
but if you have just added a new dependency and you want to force it
|
|
|
|
to fetch it, you can do that too:
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
$ lein deps
|
|
|
|
|
2011-02-19 04:43:29 +00:00
|
|
|
Copying 3 files to ~/src/myproject/lib
|
2010-06-17 04:10:56 +00:00
|
|
|
Copied :dependencies into ~/src/myproject/lib.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
Dependencies are downloaded from Clojars, the central Maven (Java)
|
2011-05-04 02:42:31 +00:00
|
|
|
repository, and any other repositories that you add to your
|
|
|
|
project.clj file. See :repositories in
|
2010-12-03 02:16:16 +00:00
|
|
|
[sample.project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj).
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
If you've confirmed that your project will work with a number of
|
|
|
|
different versions of a given dependency, you can provide a range
|
|
|
|
instead of a single version:
|
|
|
|
|
|
|
|
[org.clojure/clojure "[1.1,1.2]"] ; <= will match 1.1.0 through 1.2.0.
|
|
|
|
|
|
|
|
See [Maven's version range
|
|
|
|
specification](http://maven.apache.org/plugins/maven-enforcer-plugin/rules/versionRanges.html)
|
2011-05-04 02:42:31 +00:00
|
|
|
for details. Don't do this unless you have manually confirmed that it
|
2010-12-07 18:33:22 +00:00
|
|
|
works with each of those versions though. You can't assume that your
|
|
|
|
dependencies will use semantic versions; some projects even introduce
|
|
|
|
backwards-incompatible changes in bugfix point releases.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## Dev Dependencies
|
|
|
|
|
|
|
|
Sometimes you want to pull in dependencies that are really only for
|
|
|
|
your convenience while developing; they aren't strictly required for
|
|
|
|
the project to function. Leiningen calls these
|
2010-06-17 04:10:56 +00:00
|
|
|
:dev-dependencies. They're listed in project.clj alongside regular
|
2010-06-16 01:58:14 +00:00
|
|
|
dependencies and downloaded when you run <tt>lein deps</tt>, but they
|
|
|
|
are not brought along when another project depends on your
|
2011-05-04 02:42:31 +00:00
|
|
|
project.
|
|
|
|
|
|
|
|
Using [swank-clojure](https://github.com/technomancy/swank-clojure)
|
2010-06-17 04:10:56 +00:00
|
|
|
for Emacs support would be a typical example; you may not want it
|
2011-05-04 02:42:31 +00:00
|
|
|
included at runtime, but it's useful while you're hacking on the
|
|
|
|
project.
|
|
|
|
|
|
|
|
Dev dependencies may include plugin code that runs in Leiningen's
|
|
|
|
process (providing additional tasks or augmenting existing ones)
|
|
|
|
or code that runs in the context of your project.
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
## Writing the Code
|
|
|
|
|
|
|
|
This is the part Leiningen can't really help you with; you're on your
|
2011-05-04 02:42:31 +00:00
|
|
|
own here. Well—not quite. Leiningen can help you with running your
|
2010-06-16 01:58:14 +00:00
|
|
|
tests.
|
|
|
|
|
|
|
|
$ lein test
|
|
|
|
|
|
|
|
Testing myproject.core-test
|
|
|
|
FAIL in (replace-me) (core_test.clj:6)
|
|
|
|
No tests have been written.
|
|
|
|
expected: false
|
|
|
|
actual: false
|
|
|
|
Ran 1 tests containing 1 assertions.
|
|
|
|
1 failures, 0 errors.
|
|
|
|
|
|
|
|
Of course, we haven't written any tests yet, so we've just got the
|
|
|
|
skeleton failing tests that Leiningen gave us with <tt>lein
|
|
|
|
new</tt>. But once we fill it in the test suite will become more
|
|
|
|
useful. Sometimes if you've got a large test suite you'll want to run
|
2010-06-19 03:56:36 +00:00
|
|
|
just one or two namespaces at a time:
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
$ lein test myproject.parser-test
|
|
|
|
|
|
|
|
Testing myproject.parser-test
|
|
|
|
Ran 2 tests containing 10 assertions.
|
|
|
|
0 failures, 0 errors.
|
|
|
|
|
2010-11-10 06:20:22 +00:00
|
|
|
Rather than running your whole suite or just a few namespaces at a
|
|
|
|
time, you can run a subset of your tests using test selectors. To do
|
|
|
|
this, you attach metadata to various deftests.
|
|
|
|
|
|
|
|
(deftest ^{:integration true} network-heavy-test
|
|
|
|
(is (= [1 2 3] (:numbers (network-operation)))))
|
|
|
|
|
|
|
|
Then add a :test-selectors map to project.clj:
|
|
|
|
|
|
|
|
:test-selectors {:default (fn [v] (not (:integration v)))
|
|
|
|
:integration :integration
|
|
|
|
:all (fn [_] true)}
|
|
|
|
|
|
|
|
Now if you run "lein test" it will only run deftests that don't have
|
|
|
|
:integration metadata, while "lein test :integration" will only run
|
2010-11-10 21:10:49 +00:00
|
|
|
the integration tests and "lein test :all" will run everything. You
|
2011-04-10 00:48:45 +00:00
|
|
|
can include test selectors and listing test namespaces in the same
|
|
|
|
run. Note that this feature requires an additional entry in the
|
|
|
|
:dependencies listing to function:
|
|
|
|
|
|
|
|
[robert/hooke "1.1.0"]
|
2010-11-10 06:20:22 +00:00
|
|
|
|
2010-11-21 06:22:51 +00:00
|
|
|
Running "lein test" from the command-line is not a good solution for
|
|
|
|
test-driven development due to the slow startup time of the JVM. For
|
|
|
|
quick feedback, try starting an interactive session with "lein int"
|
|
|
|
and running tests from in there. Other options include editor
|
|
|
|
integration (see
|
2010-12-03 02:16:16 +00:00
|
|
|
[clojure-test-mode](https://github.com/technomancy/clojure-mode) for
|
2011-05-04 02:42:31 +00:00
|
|
|
Emacs) or keeping a repl open and calling <tt>run-tests</tt> from
|
|
|
|
there as you work.
|
2010-08-11 03:21:19 +00:00
|
|
|
|
2010-11-21 06:22:51 +00:00
|
|
|
Keep in mind that while keeping a single process around is convenient,
|
|
|
|
it's easy for that process to get into a state that doesn't reflect
|
2011-05-04 02:42:31 +00:00
|
|
|
the files on disk—functions that are loaded and then deleted from the
|
2010-11-21 06:22:51 +00:00
|
|
|
file will remain in memory, making it easy to miss problems arising
|
2011-05-04 02:42:31 +00:00
|
|
|
from missing functions (often referred to as "getting
|
|
|
|
slimed"). Because of this it's advised to do a "lein test" run with a
|
|
|
|
fresh instance periodically, perhaps before you commit.
|
2010-11-21 06:22:51 +00:00
|
|
|
|
2011-05-04 02:42:31 +00:00
|
|
|
## AOT Compiling
|
2010-06-16 01:58:14 +00:00
|
|
|
|
|
|
|
If you're lucky you'll be able to get away without doing any AOT
|
2010-06-17 04:10:56 +00:00
|
|
|
(ahead-of-time) compilation. But there are some Java interop features
|
2010-06-17 04:19:04 +00:00
|
|
|
that require it, so if you need to use them you should add an :aot
|
2010-06-17 04:10:56 +00:00
|
|
|
option into your project.clj file. It should be a seq of namespaces
|
|
|
|
you want AOT-compiled. Again, the
|
2010-12-03 02:16:16 +00:00
|
|
|
[sample.project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
|
2010-06-17 04:10:56 +00:00
|
|
|
has example usage.
|
|
|
|
|
2010-08-20 03:53:40 +00:00
|
|
|
Like dependencies, this should happen for you automatically when
|
|
|
|
needed, but if you need to force it you can:
|
2010-06-17 04:10:56 +00:00
|
|
|
|
|
|
|
$ lein compile
|
|
|
|
|
|
|
|
Compiling myproject.core
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-06-30 03:31:44 +00:00
|
|
|
For your code to compile, it must be run. This means that you
|
2011-03-16 01:45:04 +00:00
|
|
|
shouldn't have any code with side-effects in the top-level. Anything
|
2011-05-04 02:42:31 +00:00
|
|
|
outside a function definition that doesn't start with <tt>def</tt> is
|
2011-03-16 01:45:04 +00:00
|
|
|
suspect. If you have code that should run on startup, place it in a
|
|
|
|
<tt>-main</tt> function as explained below under "Uberjar".
|
2010-06-30 03:31:44 +00:00
|
|
|
|
2010-11-10 06:20:22 +00:00
|
|
|
For projects that include some Java code, you can set the
|
|
|
|
<tt>:java-source-path</tt> key in project.clj to a directory
|
|
|
|
containing Java files. Then the javac compiler will run before your
|
|
|
|
Clojure code is AOT-compiled, or you can run it manually with the
|
|
|
|
<tt>javac</tt> task.
|
2010-11-07 23:50:25 +00:00
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
There's
|
|
|
|
[a problem in Clojure](http://dev.clojure.org/jira/browse/CLJ-322)
|
|
|
|
where AOT-compiling a namespace will also AOT compile all the
|
|
|
|
namespaces it depends upon. This often causes unrelated compilation
|
|
|
|
artifacts to be included in the jars, but you can set
|
|
|
|
:class-file-whitelist to a regex which will be matched against .class
|
|
|
|
file names you want to keep in order to remove the unwanted file.
|
2010-11-07 23:50:25 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
## What to do with it
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
Generally speaking, there are three different goals that are typical
|
|
|
|
of Leiningen projects:
|
2010-06-17 04:10:56 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
* An application you can distribute to end-users
|
|
|
|
* A server-side application
|
2011-05-13 15:15:54 +00:00
|
|
|
* A library for other Clojure projects to consume
|
2010-06-17 04:10:56 +00:00
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
For the first, you typically either build an uberjar or use a
|
|
|
|
shell-wrapper. For libraries, you will want to have them published to
|
|
|
|
a repository like Clojars or a private repository. For server-side
|
|
|
|
applications it varies as described below.
|
2010-06-19 03:56:36 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
### Uberjar
|
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
The simplest thing to do is to distribute an uberjar. This is a single
|
2010-09-05 22:19:18 +00:00
|
|
|
standalone executable jar file most suitable for giving to
|
|
|
|
nontechnical users. For this to work you'll need to specify a
|
|
|
|
namespace as your :main in project.clj. By this point our project.clj
|
|
|
|
file should look like this:
|
2010-06-29 19:58:23 +00:00
|
|
|
|
|
|
|
(defproject myproject "1.0.0-SNAPSHOT"
|
|
|
|
:description "This project is MINE."
|
2010-11-20 18:12:52 +00:00
|
|
|
:dependencies [[org.clojure/clojure "1.2.0"]
|
2010-06-29 19:58:23 +00:00
|
|
|
[org.apache.lucene/lucene-core "3.0.2"]
|
2011-03-16 01:45:04 +00:00
|
|
|
[lancet "1.0.0"]]
|
2010-06-29 19:58:23 +00:00
|
|
|
:main myproject.core)
|
|
|
|
|
|
|
|
The namespace you specify will need to contain a <tt>-main</tt>
|
|
|
|
function that will get called when your standalone jar is run. This
|
|
|
|
namespace should have a <tt>(:gen-class)</tt> declaration in the
|
|
|
|
<tt>ns</tt> form at the top. The <tt>-main</tt> function will get
|
|
|
|
passed the command-line arguments. Let's try something simple in
|
|
|
|
src/myproject/core.clj:
|
2010-06-17 04:10:56 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
(ns myproject.core
|
|
|
|
(:gen-class))
|
2010-06-16 01:58:14 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
(defn -main [& args]
|
|
|
|
(println "Welcome to my project! These are your args:" args))
|
2010-06-17 04:10:56 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
Now we're ready to generate your uberjar:
|
2010-06-17 04:10:56 +00:00
|
|
|
|
|
|
|
$ lein uberjar
|
2010-06-29 19:58:23 +00:00
|
|
|
Cleaning up
|
2011-02-19 04:43:29 +00:00
|
|
|
Copying 3 files to /home/phil/src/leiningen/myproject/lib
|
2010-06-17 04:10:56 +00:00
|
|
|
Created ~/src/myproject/myproject-1.0.0.jar
|
2010-06-29 19:58:23 +00:00
|
|
|
Including myproject-1.0.0-SNAPSHOT.jar
|
2011-03-16 01:45:04 +00:00
|
|
|
Including lancet-1.0.0.jar
|
2010-11-20 18:12:52 +00:00
|
|
|
Including clojure-1.2.0.jar
|
2010-06-29 19:58:23 +00:00
|
|
|
Including lucene-core-3.0.2.jar
|
2010-06-17 04:19:04 +00:00
|
|
|
Created myproject-1.0.0-standalone.jar
|
2010-06-17 04:10:56 +00:00
|
|
|
|
|
|
|
This creates a single jar file that contains the contents of all your
|
2010-06-17 04:19:04 +00:00
|
|
|
dependencies. Users can run it with a simple <tt>java</tt> invocation,
|
|
|
|
or on some systems just by double-clicking the jar file.
|
2010-06-17 04:10:56 +00:00
|
|
|
|
2010-06-29 19:58:23 +00:00
|
|
|
$ java -jar myproject-1.0.0-standalone.jar Hello world.
|
|
|
|
Welcome to my project! These are your args: (Hello world.)
|
|
|
|
|
|
|
|
You can run a regular (non-uber) jar with the <tt>java</tt>
|
|
|
|
command-line tool, but that requires constructing the classpath
|
|
|
|
yourself, so it's not a good solution for end-users.
|
|
|
|
|
2010-11-10 06:20:22 +00:00
|
|
|
Invoking "lein run" will launch your project's -main function as if
|
|
|
|
from an uberjar, but without going through the packaging process. You
|
|
|
|
can also specify an alternate namespace in which to look for -main
|
|
|
|
with "lein run -m my.alternate.namespace ARG1 ARG2".
|
2010-11-07 23:50:25 +00:00
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
### Shell Wrappers
|
|
|
|
|
|
|
|
There are a few downsides to uberjars. It's relatively awkward to
|
|
|
|
invoke them compared to other command-line tools. You also can't
|
|
|
|
control how the JVM is launched. To solve this, you can include a
|
|
|
|
shell script in your jar file that can be used to launch the
|
|
|
|
project. Leiningen places this shell script into the
|
2010-09-05 22:19:18 +00:00
|
|
|
<tt>~/.lein/bin</tt> directory at install time. Of course, this is
|
|
|
|
only suitable if your users already use Leiningen.
|
2010-08-18 05:21:53 +00:00
|
|
|
|
|
|
|
If you simply include <tt>:shell-wrapper true</tt> in your
|
|
|
|
project.clj, Leiningen automatically generates a simple shell script
|
|
|
|
wrapper when you create your jar file. However, if you need more
|
|
|
|
control you can provide a map instead:
|
|
|
|
|
|
|
|
:shell-wrapper {:main myproject.core
|
|
|
|
:bin "bin/myproject"}
|
|
|
|
|
|
|
|
Normally the shell wrapper will invoke the -main function in your
|
|
|
|
project's :main namespace, but specifying this option triggers AOT for
|
|
|
|
uberjars, so if you wish to avoid this or use a different :main for
|
|
|
|
the shell wrapper vs uberjar you can specify a :main ns inside the
|
|
|
|
:shell-wrapper map. You may also specify a :bin key, which should
|
2010-08-21 01:59:12 +00:00
|
|
|
point to a file relative to the project's root to use as a shell
|
2010-08-18 05:21:53 +00:00
|
|
|
wrapper template instead of the default. The <tt>format</tt> function
|
|
|
|
is called with the contents of this file along with the necessary
|
|
|
|
classpath and the main namespace, so put %s in the right place. See
|
|
|
|
[the default
|
2010-12-03 02:16:16 +00:00
|
|
|
wrapper](https://github.com/technomancy/leiningen/blob/stable/resources/script-template)
|
2010-08-18 05:21:53 +00:00
|
|
|
for an example.
|
2010-08-17 05:05:24 +00:00
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
### Server-side Projects
|
|
|
|
|
|
|
|
There are many ways to get your project deployed as a server-side
|
|
|
|
application. Simple programs can be packaged up as tarballs with
|
|
|
|
accompanied shell scripts using the
|
|
|
|
[lein-tar plugin](https://github.com/technomancy/lein-tar) and then
|
|
|
|
deployed using [pallet](http://hugoduncan.github.com/pallet/),
|
|
|
|
[chef](http://opscode.com/chef/), or other mechanisms. Debian packages
|
|
|
|
can be created with
|
|
|
|
[lein-deb](https://github.com/travis/lein-deb). Web applications may
|
2011-05-13 15:15:54 +00:00
|
|
|
be deployed using .war (web application archive) files created by the
|
2011-03-16 01:45:04 +00:00
|
|
|
[lein-ring plugin](https://github.com/weavejester/lein-ring). You
|
|
|
|
can even create
|
|
|
|
[Hadoop projects](https://github.com/ndimiduk/lein-hadoop). These
|
|
|
|
kinds of deployments are so varied that they are better-handled using
|
|
|
|
plugins rather than tasks that are built-in to Leiningen itself.
|
|
|
|
|
2011-05-13 15:15:54 +00:00
|
|
|
It may be tempting to deploy by just checking out your project and
|
|
|
|
using "lein run" on production servers. However, it's much better to
|
|
|
|
use Leiningen to create a deployable artifact in a continuous
|
|
|
|
integration setting instead. This makes deployments much more
|
|
|
|
repeatable. For example, you could have a
|
|
|
|
[Jenkins](http://jenkins-ci.org) CI server run your project's full
|
|
|
|
test suite, and if it passes, upload a tarball to S3. Then deployment
|
|
|
|
is just a matter of pulling down and extracting the known-good tarball
|
|
|
|
on your production servers.
|
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
### Publishing Libraries
|
2010-06-29 19:58:23 +00:00
|
|
|
|
|
|
|
If your project is a library and you would like others to be able to
|
|
|
|
use it as a dependency in their projects, you will need to get it into
|
2011-05-04 02:42:31 +00:00
|
|
|
a public repository. While it's possible to
|
|
|
|
[maintain your own private repository](https://github.com/technomancy/leiningen/blob/stable/DEPLOY.md)
|
|
|
|
or get it into Maven central, the easiest way is to publish it at
|
|
|
|
[Clojars](http://clojars.org). Once you have created an account there,
|
|
|
|
publishing is easy:
|
2010-06-29 19:58:23 +00:00
|
|
|
|
2011-03-10 03:45:36 +00:00
|
|
|
$ lein jar, pom
|
2010-06-29 19:58:23 +00:00
|
|
|
$ scp pom.xml myproject-1.0.0.jar clojars@clojars.org:
|
|
|
|
|
|
|
|
Once that succeeds it will be available as a package on which other
|
|
|
|
projects may depend. You will need to have permission to publish to
|
|
|
|
the project's group-id under Clojars, though if that group-id doesn't
|
|
|
|
exist yet then Clojars will automatically create it and give you
|
|
|
|
permissions.
|
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
For further details about publishing including setting up private
|
|
|
|
repositories, see the [deploy guide](https://github.com/technomancy/leiningen/blob/stable/DEPLOY.md)
|
2010-06-17 04:10:56 +00:00
|
|
|
|
|
|
|
## That's It!
|
|
|
|
|
2011-03-16 01:45:04 +00:00
|
|
|
Now go start coding your next project!
|