Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 3.42 KB

README.md

File metadata and controls

71 lines (49 loc) · 3.42 KB
Raw

hydrogen.module.core for Duct

It implements a module for Duct. hydrogen.module.core brings in config for doing SPAs the Hydrogen way.

Installation

Clojars Project Build Status

Usage

{:hydrogen.module/core {}}

And a more realistic set of examples. First example: setting the paths for externs files, both for development and production:

{:hydrogen.module/core
  {:externs-paths {:production ["src/my-app/client/externs.js"
                                "src/my-app/client/google_maps_api_v3_36.js"]
                   :development ["oksol/client/google_maps_api_v3_36.js"]}}}

Second example: in addition to setting the paths for externs files, also enable Figwheel-main instead of using lein-figwheel. Using Figwheel-main default configuration options:

{:hydrogen.module/core
  {:figwheel-main {}
   :externs-paths {:production ["src/my-app/client/externs.js"
                                "src/my-app/client/google_maps_api_v3_36.js"]
                   :development ["oksol/client/google_maps_api_v3_36.js"]}}}

Third example: in addition to the previous configuration, we set explicit values for all Figwheel-main configuration options supported by the module (see below):

{:hydrogen.module/core
  {:figwheel-main {:port 3449
                   :host "0.0.0.0"
                   :watch-dirs ["src/my-app/client/"]
                   :reload-clj-files #{:cljc}}
   :externs-paths {:production ["src/my-app/client/externs.js"
                                "src/my-app/client/google_maps_api_v3_36.js"]
                   :development ["oksol/client/google_maps_api_v3_36.js"]}}}

Important!

As of version 0.3.0 this module supports new config syntax suitable for Figwheel-main. Make sure to add at least :figwheel-main {} if you want to use Figwheel-main. You can also specify the following Figwheel-main configuration options: :host and :port for :ring-server-options, :watch-dirs and :reload-clj-files.

Additional options

  • Externs[1] - to configure them use :externs-paths option. It accepts two formats:
    • {:externs-paths ["a.js" "b.js"]} - this would apply both files as externs both in development environment (as part of :duct.server/figwheel config) and in production environment (as part of :duct.compiler/cljs config).
    • {:externs-paths {:production ["a.js"] :development ["x.js" "y.js"]}}

[1]Note

Figwheel expects files with .js extension inside its source directories to be a foreign library. And foreign libraries MUST declare a namespace. In fact, figwheel assumes it, and if it doesn't find it and can't map the file back to a source file, it bombs out with a NullPointerException.

So even if externs files are NOT foreign libraries, make sure you add a namespace declaration to your externs files to prevent figwheel from crashing.

Like this: goog.provide('google.maps');

License

Copyright (c) 2021 Magnet S Coop.

The source code for the library is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.