diff --git a/README.md b/README.md index 9b1c5f38..ac6be7ed 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ to install and allows you to configure the ClojureScript compiler from within yo Beyond basic compiler support, lein-cljsbuild can optionally help with a few other things: -* [Launching REPLs for interactive development] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/REPL.md) -* [Launching ClojureScript tests] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/TESTING.md) -* [Sharing code between Clojure and ClojureScript] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/CROSSOVERS.md) +* [Launching REPLs for interactive development] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/REPL.md) +* [Launching ClojureScript tests] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/TESTING.md) +* [Sharing code between Clojure and ClojureScript] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/CROSSOVERS.md) ## Requirements @@ -25,7 +25,7 @@ adding lein-cljsbuild to your `project.clj` file in the `:plugins` section: ```clj ; Using Leiningen 1.7.0 or newer: (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]]) + :plugins [[lein-cljsbuild "0.1.2"]]) ``` For versions of Leiningen older than `1.7.0` (not recommended), add @@ -34,7 +34,7 @@ lein-cljsbuild to the `:dev-dependencies` section instead: ```clj ; Using Leiningen 1.6.x or older: (defproject lein-cljsbuild-example "1.2.3" - :dev-dependencies [[lein-cljsbuild "0.1.1"]]) + :dev-dependencies [[lein-cljsbuild "0.1.2"]]) ``` Make sure you pull down the jar file: @@ -45,21 +45,21 @@ Make sure you pull down the jar file: The `:cljsbuild` configuration format has changed. This version is backwards-compatible with `0.0.x`, but the next major version won't be. See the -[migration documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/MIGRATING-TO-0.1.1.md) +[migration documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/MIGRATING-TO-0.1.2.md) for details. ## Just Give Me a Damned Example Already! See the -[example-projects] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects) +[example-projects] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects) directory for a couple of simple examples of how to use lein-cljsbuild. The -[simple project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/simple) +[simple project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/simple) shows a dead-simple "compile only" configuration, which is a good place to start. The -[advanced project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/advanced) +[advanced project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/advanced) contains examples of how to use the extended features of the plugin. Also, see the -[sample.project.clj] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/sample.project.clj) +[sample.project.clj] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/sample.project.clj) file for an exhaustive list of all options supported by lein-cljsbuild. ## Basic Configuration @@ -69,7 +69,7 @@ of your `project.clj` file. A simple project might look like this: ```clj (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]] + :plugins [[lein-cljsbuild "0.1.2"]] :cljsbuild { :builds [{ ; The path to the top-level ClojureScript source directory: @@ -83,7 +83,7 @@ of your `project.clj` file. A simple project might look like this: ``` For an exhaustive list of the configuration options supported by lein-cljsbuild, see the -[sample.project.clj] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/sample.project.clj) +[sample.project.clj] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/sample.project.clj) file. ## Basic Usage @@ -131,7 +131,7 @@ JAR file. ``` If you are using the -[crossovers] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/CROSSOVERS.md) +[crossovers] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/CROSSOVERS.md) feature, and want the `:crossover-path` included in the JAR file, add this entry to your top-level `:cljsbuild` configuration: @@ -147,7 +147,7 @@ and will build all of them in parallel: ```clj (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]] + :plugins [[lein-cljsbuild "0.1.2"]] :cljsbuild { :builds [ {:source-path "src-cljs-main" @@ -161,27 +161,27 @@ This allows cljsbuild to compile in all four optimization levels at once, for easier testing, or to compile a test suite alongside the library code. See the -[example-projects/advanced] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/advanced) +[example-projects/advanced] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/advanced) directory for a working example of a project that uses this feature. ## REPL Support Lein-cljsbuild has built-in support for launching ClojureScript REPLs in a variety of ways. See the -[REPL documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/REPL.md) +[REPL documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/REPL.md) for more details. ## Testing Support Lein-cljsbuild has built-in support for running external ClojureScript test processes. See the -[testing documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/TESTING.md) +[testing documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/TESTING.md) for more details. ## Sharing Code Between Clojure and ClojureScript Sharing code with lein-cljsbuild is accomplished via the configuration of "crossovers". See the -[crossovers documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/doc/CROSSOVERS.md) +[crossovers documentation] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/doc/CROSSOVERS.md) for more details. ## License diff --git a/doc/CROSSOVERS.md b/doc/CROSSOVERS.md index ddde8987..6318d935 100644 --- a/doc/CROSSOVERS.md +++ b/doc/CROSSOVERS.md @@ -35,7 +35,7 @@ And your `project.clj` file looks like this: ```clj (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]] + :plugins [[lein-cljsbuild "0.1.2"]] :source-path "src-clj" :cljsbuild { ; Each entry in the :crossovers vector describes a Clojure namespace diff --git a/doc/MIGRATING-TO-0.1.0.md b/doc/MIGRATING-TO-0.1.0.md index 08a391e7..4a0373b7 100644 --- a/doc/MIGRATING-TO-0.1.0.md +++ b/doc/MIGRATING-TO-0.1.0.md @@ -1,9 +1,9 @@ # Migrating from 0.0.x to 0.1.x -The `0.1.1` release of lein-cljsbuild adds several new features that necessitate +The `0.1.2` release of lein-cljsbuild adds several new features that necessitate some changes to the format of the `:cljsbuild` configuration entry. -With that said, `0.1.1` **is** backwards-compatible with your existing configuration. +With that said, `0.1.2` **is** backwards-compatible with your existing configuration. However, it will be complaining loudly about how it's deprecated. This document explains how to fix that. @@ -17,7 +17,7 @@ that may be renamed in the new version. Most importantly, it will remove any cr that have been copied into place. **This is very important. If you are using crossovers, skipping this step will cause pain!** -Once you've updated your project to use `[lein-cljsbuild "0.1.1"]`, run any subcommand, +Once you've updated your project to use `[lein-cljsbuild "0.1.2"]`, run any subcommand, for instance, `lein cljsbuild once`. The plugin will complain that your configuration is deprecated. However, it should automatically convert your `:cljsbuild` entry to the new format, and print it out. diff --git a/doc/REPL.md b/doc/REPL.md index 795ebaa4..d804112b 100644 --- a/doc/REPL.md +++ b/doc/REPL.md @@ -60,7 +60,7 @@ between them. To configure a launch preset, add an entry to the `:repl-launch-c ```clj (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]] + :plugins [[lein-cljsbuild "0.1.2"]] :cljsbuild { :repl-listen-port 9000 :repl-launch-commands @@ -99,7 +99,7 @@ treated as an option map. Currently, the only supported options are ``` For more ideas on how to use `repl-launch`, take a look at the -[advanced example project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/advanced) +[advanced example project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/advanced) It has several examples of useful launch commands, with descriptions in its README. Note that, in particular, the possibilities with [PhantomJS] (http://www.phantomjs.org) diff --git a/doc/TESTING.md b/doc/TESTING.md index 4d77f4f5..b6305b04 100644 --- a/doc/TESTING.md +++ b/doc/TESTING.md @@ -7,7 +7,7 @@ test: ```clj (defproject lein-cljsbuild-example "1.2.3" - :plugins [[lein-cljsbuild "0.1.1"]] + :plugins [[lein-cljsbuild "0.1.2"]] :cljsbuild { :test-commands {"my-test" ["phantomjs" "phantom/unit-test.js" "..."]}) @@ -38,7 +38,7 @@ browser to do, except it does not have a GUI. PhantomJS can be automated via Ja and thus is convenient to use for running automated tests. The -[advanced example project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/advanced) +[advanced example project] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/advanced) contains an example of how to use PhantomJS for running ClojureScript tests. There are several components that come together to make this work: @@ -46,10 +46,10 @@ components that come together to make this work: the unit tests into JavaScript (so that it they can be run by PhantomJS). 2. A -[static HTML page] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.1/example-projects/advanced/resources/private/html/unit-test.html) +[static HTML page] (https://github.com/emezeske/lein-cljsbuild/blob/0.1.2/example-projects/advanced/resources/private/html/unit-test.html) with a `