Skip to content

Commit

Permalink
Added with-repl sections in README.md and CHANGES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony D'Ambrosio committed Feb 23, 2016
1 parent 679e353 commit a07cb93
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
6 changes: 5 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changes

## NEXT

- Can now use the `:with-repl` flag to start a REPL for interacting with your project.

## 0.13.0

- Adds support for running tests once with the flag `:run-once`.
Expand Down Expand Up @@ -111,7 +115,7 @@ test namespace`.

- Nothing. This was an accidental release due to testing the release
script.

## 0.3.7

- Change success message to 'Passed all tests'
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ your `clojure.test` tests when a file in your project changes
- Supports `clojure.test`'s custom reports.
- Supports running your tests once! Useful for taking advantage of
custom test reporters or quiet output in CI systems.
- Has optional repl support for changing global state, such as timbre logging levels

[sample.project.clj](sample.project.clj) show optional configuration.
It and the rest of this readme should be used as documentation as to
Expand Down Expand Up @@ -62,10 +63,10 @@ output will look something like this.
*************** Running tests ***************

<standard clojure.test output>

Failed 1 of 215 assertions
Finished at 08:25:20.619 (run time: 9.691s)

Your terminal will just stay like that. Fairly often `lein-test-refresh`
polls the file system to see if anything has changed. When there is a
change your code is tested again.
Expand All @@ -92,7 +93,7 @@ For example, if you want to send OSX notifications using
you would add the following to your `project.clj` or `profiles.clj`

```clojure
:test-refresh {:notify-command ["terminal-notifier" "-title" "Tests" "-message"]}
:test-refresh {:notify-command ["terminal-notifier" "-title" "Tests" "-message"]}
```

`lein-test-refresh` also has built-in Growl support. To receive Growl
Expand Down Expand Up @@ -150,6 +151,16 @@ profiles.clj) or pass it as a command line option. Check out

Using it at the command line looks like `lein test-refresh :run-once`.

### Running with a REPL

`lein-test-refresh` can be run with `:with-repl` which will start up a repl
that you can interact with inbetween test runs. The main reason for this option
is that sometimes you want to affect global state in your application.
An example is when you see a test failure, you can call
`(taoensso.timbre/set-level! :debug)` and see more information.

See [this](https://github.com/jakemcc/lein-test-refresh/pull/50) pull request for details.

## Contributing

I encourage pull requests. If you're making a large change it is
Expand Down

0 comments on commit a07cb93

Please # to comment.