2010-08-08 18:11:48 +00:00
|
|
|
# Hacking Leiningen
|
|
|
|
|
|
2011-11-21 20:30:40 +00:00
|
|
|
Leiningen is composed of a few layers. First we have the
|
|
|
|
|
`leiningen-core` library, which implements the basic project-centric
|
|
|
|
|
functionality that would be useful outside the context of Leiningen
|
|
|
|
|
itself, primarily for IDEs and other tools. This is available
|
|
|
|
|
independently on [Clojars](http://clojars.org/leiningen-core) and
|
|
|
|
|
documented at TODO
|
2010-08-20 03:53:40 +00:00
|
|
|
|
2010-08-08 18:11:48 +00:00
|
|
|
When you launch Leiningen, it must start an instance of Clojure to
|
2010-09-26 05:15:01 +00:00
|
|
|
load itself. But this instance must not affect the project that you're
|
2010-08-08 18:11:48 +00:00
|
|
|
building. It may use a different version of Clojure from Leiningen,
|
|
|
|
|
and the project should be in a fresh JVM. Leiningen uses ant's
|
|
|
|
|
<tt>java</tt> task to fork off a separate process for this
|
|
|
|
|
purpose. The <tt>leiningen.compile</tt> namespace implements this;
|
|
|
|
|
specifically the <tt>eval-in-project</tt> function. Any code that must
|
|
|
|
|
execute within the context of the project (AOT compilation, test runs)
|
|
|
|
|
needs to go through this function.
|
|
|
|
|
|
2011-03-16 01:50:02 +00:00
|
|
|
The exception to this rule is when <tt>:eval-in-leiningen</tt> in
|
|
|
|
|
project.clj is true, as is commonly used for Leiningen plugins.
|
2010-11-19 05:39:44 +00:00
|
|
|
|
|
|
|
|
TODO: what goes where? a tour through the launching of a task
|
2010-11-07 23:50:25 +00:00
|
|
|
|
2010-08-08 18:11:48 +00:00
|
|
|
Leiningen is extensible; you can define new tasks in plugins. Add your
|
|
|
|
|
plugin as a dev-dependency of your project, and you'll be able to call
|
2011-07-06 16:03:03 +00:00
|
|
|
<tt>lein $YOUR_COMMAND</tt>. See the [plugins guide](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md) for details.
|
2010-08-08 18:11:48 +00:00
|
|
|
|
|
|
|
|
The [mailing list](http://groups.google.com/group/leiningen) and the
|
|
|
|
|
leiningen or clojure channels on Freenode are the best places to
|
|
|
|
|
bring up questions or suggestions. If you're planning on adding a
|
|
|
|
|
feature or fixing a nontrivial bug, please discuss it first to avoid
|
|
|
|
|
duplicating effort. If you haven't discussed it on the mailing list,
|
|
|
|
|
please include in your pull request details of what problem your patch
|
2010-09-26 05:15:01 +00:00
|
|
|
intends to solve as well as the approach you took.
|
2010-08-08 18:11:48 +00:00
|
|
|
|
|
|
|
|
Contributions are preferred as either Github pull requests or using
|
|
|
|
|
"git format-patch" and the mailing list as is requested [for
|
|
|
|
|
contributing to Clojure itself](http://clojure.org/patches). Please
|
|
|
|
|
use standard indentation with no tabs, trailing whitespace, or lines
|
|
|
|
|
longer than 80 columns. See [this post on submitting good
|
|
|
|
|
patches](http://technomancy.us/135) for some tips. If you've got some
|
|
|
|
|
time on your hands, reading this [style
|
|
|
|
|
guide](http://mumble.net/~campbell/scheme/style.txt) wouldn't hurt
|
|
|
|
|
either.
|
|
|
|
|
|
2010-12-03 02:16:16 +00:00
|
|
|
See the [complete list of known issues](https://github.com/technomancy/leiningen/issues).
|
2010-08-08 18:11:48 +00:00
|
|
|
|
|
|
|
|
TODO: integrate with plugin guide
|
|
|
|
|
|
|
|
|
|
# Release Checklist
|
|
|
|
|
|
2010-09-05 22:19:18 +00:00
|
|
|
* update NEWS, bin/lein, bin/lein.bat, project.clj, pom
|
2011-03-16 01:50:02 +00:00
|
|
|
* rm -rf lib classes, compile :all, generate uberjar, upload
|
2010-08-08 18:11:48 +00:00
|
|
|
* test self-install
|
2010-08-20 20:58:50 +00:00
|
|
|
* git tag
|
2010-08-08 18:11:48 +00:00
|
|
|
* push, push tags, update stable branch
|
|
|
|
|
* announce on mailing list
|
2010-09-08 21:06:17 +00:00
|
|
|
* bump version numbers (bin/lein, bin/lein.bat, project.clj)
|
2010-08-08 18:11:48 +00:00
|
|
|
* regenerate pom.xml
|
