2009-10-31 21:35:25 +00:00
|
|
|
# Leiningen
|
|
|
|
|
2009-11-12 05:25:16 +00:00
|
|
|
> "Leiningen!" he shouted. "You're insane! They're not creatures you can
|
|
|
|
> fight--they're an elemental--an 'act of God!' Ten miles long, two
|
|
|
|
> miles wide--ants, nothing but ants! And every single one of them a
|
2009-12-21 04:37:19 +00:00
|
|
|
> fiend from hell..."
|
2009-11-12 05:25:16 +00:00
|
|
|
> -- from Leiningen Versus the Ants by Carl Stephenson
|
2009-10-31 21:35:25 +00:00
|
|
|
|
|
|
|
Leiningen is a build tool for Clojure designed to not set your hair on fire.
|
|
|
|
|
2010-07-26 19:21:05 +00:00
|
|
|
<img src="http://github.com/downloads/technomancy/leiningen/leiningen-banner.png" alt="Leiningen logo" title="The man himself" align="right" />
|
2010-07-18 20:28:49 +00:00
|
|
|
|
2009-11-15 04:56:52 +00:00
|
|
|
Building Clojure projects with tools designed for Java can be an
|
|
|
|
exercise in frustration. If you use Ant, you end up copying around a
|
2010-06-19 03:56:36 +00:00
|
|
|
lot of the same tasks between XML files on all your projects;
|
2009-11-15 04:56:52 +00:00
|
|
|
there's a lot of repetition. Maven avoids repetition, but provides
|
|
|
|
very little transparency into what's really going on behind the scenes
|
|
|
|
and forces you to become a Maven expert to script a nontrivial
|
2010-06-15 05:23:13 +00:00
|
|
|
build. Either way you must write far more XML than is decent.
|
2009-11-15 04:56:52 +00:00
|
|
|
|
2010-08-08 18:11:48 +00:00
|
|
|
With Leiningen, you describe your build with Clojure.
|
2009-11-15 04:56:52 +00:00
|
|
|
|
2009-11-12 05:25:16 +00:00
|
|
|
## Installation
|
2009-11-02 07:02:16 +00:00
|
|
|
|
2010-06-15 05:23:13 +00:00
|
|
|
Leiningen bootstraps itself using the <tt>lein</tt> shell script;
|
|
|
|
there is no separate 'install script'. It installs its dependencies in
|
|
|
|
$HOME/.m2/repository.
|
2010-03-13 05:04:11 +00:00
|
|
|
|
2010-01-11 17:04:32 +00:00
|
|
|
1. [Download the script](http://github.com/technomancy/leiningen/raw/stable/bin/lein).
|
2009-11-20 01:22:52 +00:00
|
|
|
2. Place it on your path and chmod it to be executable.
|
|
|
|
3. Run: <tt>lein self-install</tt>
|
2009-11-02 07:02:16 +00:00
|
|
|
|
2010-06-22 02:21:13 +00:00
|
|
|
For development versions you may use [the master version of the lein
|
2010-06-14 02:58:45 +00:00
|
|
|
script](http://github.com/technomancy/leiningen/raw/master/bin/lein) instead.
|
2009-11-24 05:26:47 +00:00
|
|
|
|
2010-03-13 05:04:11 +00:00
|
|
|
On Windows you can download
|
2010-06-19 03:56:36 +00:00
|
|
|
[lein.bat](http://github.com/technomancy/leiningen/raw/master/bin/lein.bat),
|
2010-03-13 05:04:11 +00:00
|
|
|
instead, though support on that platform is still experimental.
|
|
|
|
|
2009-10-31 21:35:25 +00:00
|
|
|
## Usage
|
|
|
|
|
2010-06-19 03:56:36 +00:00
|
|
|
The
|
|
|
|
[tutorial](http://github.com/technomancy/leiningen/blob/master/TUTORIAL.md)
|
|
|
|
has a detailed walk-through of the steps involved in creating a new
|
|
|
|
project, but here are the commonly-used tasks:
|
|
|
|
|
2010-06-05 20:26:52 +00:00
|
|
|
$ lein new NAME # generate a new project skeleton
|
|
|
|
|
2009-10-31 21:35:25 +00:00
|
|
|
$ lein deps # install dependencies in lib/
|
|
|
|
|
2009-11-29 22:20:09 +00:00
|
|
|
$ lein test [TESTS] # run the tests in the TESTS namespaces, or all tests
|
2009-11-02 06:47:21 +00:00
|
|
|
|
2010-07-18 20:28:49 +00:00
|
|
|
$ lein repl # launch an interactive REPL session
|
2009-10-31 21:35:25 +00:00
|
|
|
|
2010-06-22 02:21:13 +00:00
|
|
|
$ lein jar # package up the whole project as a .jar file
|
2009-11-09 06:09:39 +00:00
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
$ lein install [NAME VERSION] # install a project
|
|
|
|
|
2010-06-22 02:21:13 +00:00
|
|
|
Use <tt>lein help</tt> to see a complete list. <tt>lein help
|
|
|
|
$TASK</tt> shows the usage for a specific one.
|
2009-11-20 01:50:33 +00:00
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
You can also chain tasks together in a single command by using commas:
|
|
|
|
|
|
|
|
$ lein clean, test foo.test-core, jar
|
2010-08-17 05:05:24 +00:00
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
Most tasks need to be run from somewhere inside a project directory to
|
|
|
|
work, but some (<tt>new</tt>, <tt>help</tt>, <tt>version</tt> and the
|
|
|
|
two-argument version of <tt>install</tt>) may run from anywhere.
|
|
|
|
|
|
|
|
The install task places shell scripts in the <tt>~/.lein/bin</tt>
|
|
|
|
directory for projects that include them, so if you want to take
|
|
|
|
advantage of this, you should put it on your $PATH.
|
2010-08-17 05:05:24 +00:00
|
|
|
|
2009-10-31 21:35:25 +00:00
|
|
|
## Configuration
|
|
|
|
|
2010-06-15 05:23:13 +00:00
|
|
|
Place a project.clj file in the project root like this:
|
2009-10-31 21:35:25 +00:00
|
|
|
|
2009-11-15 04:47:48 +00:00
|
|
|
(defproject leiningen "0.5.0-SNAPSHOT"
|
2009-11-29 22:20:09 +00:00
|
|
|
:description "A build tool designed not to set your hair on fire."
|
2009-12-02 06:28:58 +00:00
|
|
|
:url "http://github.com/technomancy/leiningen"
|
2010-06-05 20:26:52 +00:00
|
|
|
:dependencies [[org.clojure/clojure "1.1.0]
|
|
|
|
[org.clojure/clojure-contrib "1.1.0"]
|
2009-11-15 04:47:48 +00:00
|
|
|
[ant/ant-launcher "1.6.2"]
|
|
|
|
[org.apache.maven/maven-ant-tasks "2.0.10"]]
|
2010-06-22 02:21:13 +00:00
|
|
|
:dev-dependencies [[swank-clojure "1.2.1"]])
|
2009-11-14 22:24:36 +00:00
|
|
|
|
2010-06-15 05:23:13 +00:00
|
|
|
The <tt>lein new</tt> task generates a project skeleton with an
|
|
|
|
appropriate starting point from which you can work. See the
|
|
|
|
[sample.project.clj](http://github.com/technomancy/leiningen/blob/master/sample.project.clj)
|
2010-06-19 03:56:36 +00:00
|
|
|
file for a detailed listing of configuration options.
|
2009-11-17 04:24:36 +00:00
|
|
|
|
2010-08-18 05:21:53 +00:00
|
|
|
You can also have user-level configuration that applies for all
|
|
|
|
projects. The ~/.lein/init.clj file will be loaded every time
|
|
|
|
Leiningen launches; any arbitrary code may go there. Place jars
|
|
|
|
containing plugins in ~/.lein/plugins to have them available globally
|
|
|
|
for the current user.
|
|
|
|
|
2009-11-05 04:25:13 +00:00
|
|
|
## FAQ
|
|
|
|
|
2009-11-06 04:34:14 +00:00
|
|
|
**Q:** How do you pronounce Leiningen?
|
|
|
|
**A:** It's LINE-ing-en. I think.
|
2009-11-05 04:25:13 +00:00
|
|
|
|
2009-11-06 04:34:14 +00:00
|
|
|
**Q:** What does this offer over [Lancet](http://github.com/stuarthalloway/lancet)?
|
|
|
|
**A:** Lancet is more of a library than a build tool. It doesn't predefine
|
2009-11-05 04:25:13 +00:00
|
|
|
any tasks apart from what Ant itself offers, so there is nothing
|
2009-11-14 22:24:36 +00:00
|
|
|
Clojure-specific in it. Leiningen builds on Lancet, but takes
|
|
|
|
things further. In addition, it includes some Maven functionality
|
|
|
|
for dependencies.
|
2009-11-05 04:25:13 +00:00
|
|
|
|
2009-11-06 04:34:14 +00:00
|
|
|
**Q:** But Maven is terrifying!
|
|
|
|
**A:** That's not a question. Anyway, Leiningen only uses the dependency
|
2009-11-05 04:25:13 +00:00
|
|
|
resolution parts of Maven, which are quite tame. For the actual
|
|
|
|
task execution cycles it uses Ant under the covers via Lancet.
|
|
|
|
|
2009-11-06 04:34:14 +00:00
|
|
|
**Q:** But Ant is terrifying!
|
|
|
|
**A:** That's [true](http://www.defmacro.org/ramblings/lisp.html). Ant is
|
2009-11-05 04:25:13 +00:00
|
|
|
an interpreter for a [procedural language with a regrettable
|
|
|
|
syntax](http://blogs.tedneward.com/2005/08/22/When+Do+You+Use+XML+Again.aspx).
|
2009-11-24 05:26:47 +00:00
|
|
|
But if you treat it as a standard library of build-related
|
|
|
|
functions and are able to write it with a more pleasing syntax, it's
|
|
|
|
not bad.
|
2009-11-05 04:25:13 +00:00
|
|
|
|
2010-03-13 05:04:11 +00:00
|
|
|
**Q:** What's a group ID? How do snapshots work?
|
|
|
|
**A:** See the
|
2010-06-16 01:58:14 +00:00
|
|
|
[tutorial](http://github.com/technomancy/leiningen/blob/master/TUTORIAL.md)
|
2010-06-22 02:21:13 +00:00
|
|
|
for background.
|
|
|
|
|
|
|
|
**Q:** How should I pick my version numbers?
|
|
|
|
**A:** Use [semantic versioning](http://semver.org).
|
2010-03-13 05:04:11 +00:00
|
|
|
|
2009-12-21 04:37:19 +00:00
|
|
|
**Q:** What if my project depends on jars that aren't in any repository?
|
2009-12-02 06:41:04 +00:00
|
|
|
**A:** Open-source jars can be uploaded to Clojars (see "Publishing"
|
2010-06-17 04:10:56 +00:00
|
|
|
in the tutorial), though be sure to use the group-id of
|
|
|
|
"org.clojars.$USERNAME" in order to avoid conflicts and to allow the
|
|
|
|
original authors to claim it in the future once they get around to
|
|
|
|
uploading. Alternatively you can do a one-off install into your
|
2010-06-29 19:58:41 +00:00
|
|
|
local repository in ~/.m2 with Maven. Add a dependency to
|
|
|
|
project.clj that doesn't exist in any remote repository and run
|
2010-07-18 20:28:49 +00:00
|
|
|
<tt>lein deps</tt>. It won't succeed, but the output will include
|
|
|
|
the <tt>mvn</tt> invocation to do this. It's _much_ better to get
|
|
|
|
the dependency in a remote repository for repeatability reasons
|
|
|
|
though. For teams working on private projects
|
|
|
|
[Hudson](http://hudson-ci.org/) works well.
|
2009-12-02 06:28:58 +00:00
|
|
|
|
2010-06-22 02:21:13 +00:00
|
|
|
**Q:** How do I write my own tasks?
|
|
|
|
**A:** If it's a task that may be useful to more than just your
|
|
|
|
project, you should make it into a
|
|
|
|
[plugin](http://github.com/technomancy/leiningen/blob/master/PLUGINS.md).
|
|
|
|
You can also include one-off tasks in your src/leiningen/ directory
|
|
|
|
if they're not worth spinning off; the plugin guide shows how.
|
|
|
|
|
|
|
|
**Q:** I want to hack two projects in parallel, but it's annoying to switch between them.
|
2010-07-18 20:28:49 +00:00
|
|
|
**A:** Use a feature called _checkout dependencies_. If you create
|
2010-06-22 02:21:13 +00:00
|
|
|
a directory called <tt>checkouts</tt> in your project root and
|
|
|
|
symlink some other projects into it, Leiningen will allow you to
|
|
|
|
hack on them in parallel. That means changes in the dependency will
|
|
|
|
be visible in the main project without having to go through the
|
|
|
|
whole install/switch-projects/deps/restart-swank cycle.
|
2010-03-13 05:04:11 +00:00
|
|
|
|
2009-12-21 21:37:38 +00:00
|
|
|
**Q:** Is it possible to exclude indirect dependencies?
|
2010-06-05 20:26:52 +00:00
|
|
|
**A:** Yes. Some libraries, such as log4j, depend on projects that are
|
2009-12-21 21:28:19 +00:00
|
|
|
not included in public repositories and unnecessary for basic
|
|
|
|
functionality. Projects listed as :dependencies may exclude
|
2010-06-05 20:26:52 +00:00
|
|
|
any of their dependencies by using the :exclusions key. See
|
|
|
|
sample.project.clj for details.
|
|
|
|
|
|
|
|
**Q:** It says a required artifact is missing for "super-pom". What's that?
|
|
|
|
**A:** The Maven API that Leiningen uses refers to your project as
|
|
|
|
"super-pom". It's just a quirk of the API. It probably means there
|
|
|
|
is a typo in your :dependency declaration in project.clj.
|
2009-12-21 21:28:19 +00:00
|
|
|
|
2010-06-22 02:21:13 +00:00
|
|
|
**Q:** What does java.lang.NoSuchMethodError: clojure.lang.RestFn.<init>(I)V mean?
|
|
|
|
**A:** It means you have some code that was AOT (ahead-of-time)
|
|
|
|
compiled with a different version of Clojure than the one you're
|
|
|
|
currently using. If it persists after running <tt>lein clean</tt> then it
|
|
|
|
is a problem with your dependencies. If you depend on contrib, make
|
|
|
|
sure the contrib version matches the Clojure version. Also note for
|
|
|
|
your own project that AOT compilation in Clojure is much less
|
|
|
|
important than it is in other languages. There are a few
|
|
|
|
language-level features that must be AOT-compiled to work, generally
|
|
|
|
for Java interop. If you are not using any of these features, you
|
|
|
|
should not AOT-compile your project if other projects may depend
|
|
|
|
upon it.
|
2009-12-21 04:37:19 +00:00
|
|
|
|
2010-07-28 03:13:56 +00:00
|
|
|
## Building
|
|
|
|
|
|
|
|
Generally a "lein self-install" will get you what you need.
|
2010-08-20 03:53:40 +00:00
|
|
|
Occasionally this will fail for very new SNAPSHOT versions since the
|
|
|
|
standalone jar will not have been uploaded yet.
|
2010-07-28 03:13:56 +00:00
|
|
|
|
|
|
|
If you have a copy of an older Leiningen version around (installed as
|
|
|
|
lein-stable, for example), then you can run "lein-stable deps" in your
|
|
|
|
checkout.
|
|
|
|
|
|
|
|
Otherwise you can use Maven:
|
|
|
|
|
2010-08-20 03:53:40 +00:00
|
|
|
$ mvn dependency:copy-dependencies
|
2010-07-28 03:13:56 +00:00
|
|
|
$ mv target/dependency lib
|
|
|
|
|
2010-08-20 03:53:40 +00:00
|
|
|
See the file HACKING.md for instructions on contributing.
|
2010-04-17 05:24:01 +00:00
|
|
|
|
2009-10-31 21:35:25 +00:00
|
|
|
## License
|
|
|
|
|
2010-07-21 16:00:23 +00:00
|
|
|
Copyright (C) 2009-2010 Phil Hagelberg, Alex Osborne, Dan Larkin, and
|
|
|
|
contributors.
|
2009-10-31 21:35:25 +00:00
|
|
|
|
2009-11-06 04:36:27 +00:00
|
|
|
Thanks to Stuart Halloway for Lancet and Tim Dysinger for convincing
|
|
|
|
me that good builds are important.
|
|
|
|
|
2009-10-31 21:35:25 +00:00
|
|
|
Distributed under the Eclipse Public License, the same as Clojure
|
|
|
|
uses. See the file COPYING.
|