Skip to content

Commit

Permalink
release 0.2.9
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruce Hauman committed Jun 15, 2020
1 parent ea436e3 commit 3729768
Show file tree
Hide file tree
Showing 21 changed files with 95 additions and 44 deletions.
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# 0.2.9 Use-SSL figwheel configuration option

* added `:use-ssl` figwheel configuration option as sugar to make
setting up https easier

# 0.2.8 Bug fix and build cleaning

Fixed a major bug introduced in 0.2.7 that caused extra-mains to
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ On Mac OSX with brew:
Now launch a ClojureScript REPL with:

```
clj -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.8\"}}}}" -m figwheel.main
clj -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.9\"}}}}" -m figwheel.main
```

This will first compile browser REPL code to a temp directory, and
Expand All @@ -224,7 +224,7 @@ available. So, you can get Rebel Readline behavior by simply adding it
to your dependencies.

```
clojure -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.8\"} com.bhauman/rebel-readline-cljs {:mvn/version \"0.1.4\"}}}}" -m figwheel.main
clojure -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.9\"} com.bhauman/rebel-readline-cljs {:mvn/version \"0.1.4\"}}}}" -m figwheel.main
```

As of right now using Rebel readline does create some startup overhead
Expand All @@ -245,7 +245,7 @@ directory of your project.
Ensure your `deps.edn` file has the `figwheel.main` dependencies:

```clojure
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.8"}
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}}
;; setup some development paths
:paths ["src" "target" "resources"]
Expand Down Expand Up @@ -311,7 +311,7 @@ directory of your project.
Ensure your `project.clj` file has `figwheel.main` dependencies:

```clojure
:dependencies [[com.bhauman/figwheel-main "0.2.8"]
:dependencies [[com.bhauman/figwheel-main "0.2.9"]
[com.bhauman/rebel-readline-cljs "0.1.4"]]
;; setup target as a resource path
:resource-paths ["target" "resources"]
Expand Down Expand Up @@ -449,7 +449,7 @@ ClojureScript searches for source files on the Classpath. When you add
a `re-frame` dependency like so:

```clojure
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.8"}
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}
;; adding re-frame
re-frame {:mvn/version "1.10.5"}}
Expand Down
4 changes: 2 additions & 2 deletions deps.edn
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
;; DEV for now its easier to use cider with top level deps
;; com.bhauman/figwheel-core {:local/root "/Users/bhauman/workspace/figwheel/figwheel-core"}
;; com.bhauman/figwheel-repl {:local/root "/Users/bhauman/workspace/figwheel/figwheel-repl"}
com.bhauman/figwheel-repl {:mvn/version "0.2.9-SNAPSHOT"}
com.bhauman/figwheel-core {:mvn/version "0.2.9-SNAPSHOT"}
com.bhauman/figwheel-repl {:mvn/version "0.2.9"}
com.bhauman/figwheel-core {:mvn/version "0.2.9"}

;; server
ring {:mvn/version "1.8.1"}
Expand Down
23 changes: 23 additions & 0 deletions doc/figwheel-main-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,29 @@ Default value is nil

:clean-outputs true

## :use-ssl

Takes a boolean value that if true indicates that
figwheel.main should configure its server to use https.

This mainly adds default `:ring-server-options` for

:ssl? true
:ssl-port 9533

This also changes the default `:connect-url` to
`wss://[[config-hostname]]:<ssl-port>/figwheel-connect` and the
default `:open-url` to `https://[[server-hostname]]:<ssl-port>` where
`<ssl-port>` is replaced with the `:ssl-port` from
`:ring-server-options`.

To complete your SSL configuration you will need to provide a
certificate and keys to options to `:ring-server-options` via a Java
KeyStore.

:keystore <path to java keystore>
:password <password to the java keystore>

# Rarely used options

## :open-url-wait-ms
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ On Mac OSX with brew:
Now launch a ClojureScript REPL with:

```
clj -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.8\"}}}}" -m figwheel.main
clj -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.9\"}}}}" -m figwheel.main
```

This will first compile browser REPL code to a temp directory, and
Expand All @@ -224,7 +224,7 @@ available. So, you can get Rebel Readline behavior by simply adding it
to your dependencies.

```
clojure -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.8\"} com.bhauman/rebel-readline-cljs {:mvn/version \"0.1.4\"}}}}" -m figwheel.main
clojure -Sdeps "{:deps {com.bhauman/figwheel-main {:mvn/version \"0.2.9\"} com.bhauman/rebel-readline-cljs {:mvn/version \"0.1.4\"}}}}" -m figwheel.main
```

As of right now using Rebel readline does create some startup overhead
Expand All @@ -245,7 +245,7 @@ directory of your project.
Ensure your `deps.edn` file has the `figwheel.main` dependencies:

```clojure
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.8"}
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}}
;; setup some development paths
:paths ["src" "target" "resources"]
Expand Down Expand Up @@ -311,7 +311,7 @@ directory of your project.
Ensure your `project.clj` file has `figwheel.main` dependencies:

```clojure
:dependencies [[com.bhauman/figwheel-main "0.2.8"]
:dependencies [[com.bhauman/figwheel-main "0.2.9"]
[com.bhauman/rebel-readline-cljs "0.1.4"]]
;; setup target as a resource path
:resource-paths ["target" "resources"]
Expand Down Expand Up @@ -449,7 +449,7 @@ ClojureScript searches for source files on the Classpath. When you add
a `re-frame` dependency like so:

```clojure
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.8"}
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}
;; adding re-frame
re-frame {:mvn/version "1.10.5"}}
Expand Down
10 changes: 5 additions & 5 deletions docs/assets/compiled/js/main.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions docs/config-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,29 @@ Default value is nil

:clean-outputs true

## :use-ssl

Takes a boolean value that if true indicates that
figwheel.main should configure its server to use https.

This mainly adds default `:ring-server-options` for

:ssl? true
:ssl-port 9533

This also changes the default `:connect-url` to
`wss://[[config-hostname]]:<ssl-port>/figwheel-connect` and the
default `:open-url` to `https://[[server-hostname]]:<ssl-port>` where
`<ssl-port>` is replaced with the `:ssl-port` from
`:ring-server-options`.

To complete your SSL configuration you will need to provide a
certificate and keys to options to `:ring-server-options` via a Java
KeyStore.

:keystore <path to java keystore>
:password <password to the java keystore>

# Rarely used options

## :open-url-wait-ms
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/classpaths.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Let's add the `cljs-src` path to our classpath with CLI Tools. In your
```clojure
{:deps {org.clojure/clojure {:mvn/version "1.9.0"}
org.clojure/clojurescript {:mvn/version "1.10.773"}
com.bhauman/figwheel-main {:mvn/version "0.2.8"}
com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}}
:aliases {:fig {:main-opts ["-m" "figwheel.main"]}}
;; define paths here
Expand Down Expand Up @@ -256,7 +256,7 @@ Edit `deps.edn`:
```clojure
{:deps {org.clojure/clojure {:mvn/version "1.9.0"}
org.clojure/clojurescript {:mvn/version "1.10.773"}
com.bhauman/figwheel-main {:mvn/version "0.2.8"}
com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}
:aliases {:fig {:main-opts ["-m" "figwheel.main"]}
;; add "resources" path here
Expand Down Expand Up @@ -383,7 +383,7 @@ This is just a simple matter as we just need to add `"target"` to the
```clojure
{:deps {org.clojure/clojure {:mvn/version "1.9.0"}
org.clojure/clojurescript {:mvn/version "1.10.773"}
com.bhauman/figwheel-main {:mvn/version "0.2.8"}
com.bhauman/figwheel-main {:mvn/version "0.2.9"}
com.bhauman/rebel-readline-cljs {:mvn/version "0.1.4"}
:aliases {:fig {:main-opts ["-m" "figwheel.main"]}
;; add "target" path here
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/code_splitting.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ touch deps.edn
Edit this script to look like the following:

```clojure
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.8"}}
{:deps {com.bhauman/figwheel-main {:mvn/version "0.2.9"}}
:paths ["src" "resources" "target"]}
```

Expand Down
Loading

0 comments on commit 3729768

Please sign in to comment.