(build-diff system ids)
Makes sure that the autobuilds in the system match the build-ids provided
Makes sure that the autobuilds in the system match the build-ids provided
(build-once system ids)
Builds the given ids or the current builds once
Builds the given ids or the current builds once
(build-switching-cljs-repl figwheel-system)
(build-switching-cljs-repl figwheel-system start-build-id)
(build-switching-cljs-repl {:keys [system]} start-build-id repl-options)
(clean-builds system ids)
Deletes the compiled assets for the given ids or cleans all the current autobuilds. This command stops and starts the autobuilds.
Deletes the compiled assets for the given ids or cleans all the current autobuilds. This command stops and starts the autobuilds.
(cljs-repl* system)
(cljs-repl* system start-build-id)
(cljs-repl* system start-build-id repl-options)
(create-figwheel-system config-data)
This creates a complete Figwheel only system. It conditionally adds a CSS watcher if the configuration contains :css-dirs and conditionally adds an nREPL server component if the Figwheel configuration contains an :nrepl-port key.
This takes a figwheel configuration consisting of :figwheel-options, :all-builds, and :build-ids.
If you only have a few components to add to this system then you can assoc them onto the created system before you start like so.
(def my-system (assoc (create-figwheel-system (config/fetch-config)) :html-reload (component/using (html-reloader {:watch-paths ["resources/public"]}) [:figwheel-system]) :web-server (my-webserver-component)))
This creates a complete Figwheel only system. It conditionally adds a CSS watcher if the configuration contains :css-dirs and conditionally adds an nREPL server component if the Figwheel configuration contains an :nrepl-port key. This takes a figwheel configuration consisting of :figwheel-options, :all-builds, and :build-ids. If you only have a few components to add to this system then you can assoc them onto the created system before you start like so. (def my-system (assoc (create-figwheel-system (config/fetch-config)) :html-reload (component/using (html-reloader {:watch-paths ["resources/public"]}) [:figwheel-system]) :web-server (my-webserver-component)))
(fig-status system)
Prints out the status of the running figwheel system
Prints out the status of the running figwheel system
(figwheel-cljs-repl figwheel-system)
(figwheel-cljs-repl figwheel-system build-id)
(figwheel-cljs-repl {:keys [system]} build-id repl-options)
(print-config system ids)
Prints out the build config for the given ids or all the build configs
Prints out the build config for the given ids or all the build configs
(reload-config system)
Resets the system and reloads the the confgiguration as best it can.
Resets the system and reloads the the confgiguration as best it can.
(repl-env* system)
(repl-env* system start-build-id)
(repl-env* system start-build-id repl-options)
(reset-autobuild system)
Alias for clean-builds
Alias for clean-builds
(start-autobuild system ids)
Either starts all the current autobuilds or adds the supplied build and starts autobuilding it.
Either starts all the current autobuilds or adds the supplied build and starts autobuilding it.
(start-figwheel! & args)
This function will start the figwheel system.
(start-figwheel!)
If called with no arguments it will load and validate the configuration found in your project.clj or a figwheel.edn file in the root of your project. If there is a figwheel.edn file any configuration information found in the project.clj will be ignored.
(start-figwheel! "example" "example-admin" ...)
You can also supply the build ids that you want figwheel to start autobuilding. If these ids aren't available in the builds specified in the found configuration this function will throw an error.
(start-figwheel! ;; using the configuration shape of figwheel.edn {:server-port 5000 :builds [{:id ...}]}
(start-figwheel! ;; using the configuration shape of figwheel.edn {:server-port 5000 :builds (figwheel-sidecar.config/get-project-builds) :builds-to-start ["example"]})
(start-figwheel! ;; using the soon to be deprecated legacy configuration shape {:figwheel-options { :server-port 4000 } :all-builds [{:id ...}] :build-ids ["example"]})
As seen above you can also directly supply a configuration Map that has the shape of a figwheel.edn file or the legacy format which will be deprecated in the near future.
(start-figwheel! (figwheel-sidecar.config/fetch-config) "example" "example-admin")
After supplying a configuration, you can also list the build-ids that you would like to start.
This function will start the figwheel system. (start-figwheel!) If called with no arguments it will load and validate the configuration found in your project.clj or a figwheel.edn file in the root of your project. If there is a figwheel.edn file any configuration information found in the project.clj will be ignored. (start-figwheel! "example" "example-admin" ...) You can also supply the build ids that you want figwheel to start autobuilding. If these ids aren't available in the builds specified in the found configuration this function will throw an error. (start-figwheel! ;; using the configuration shape of figwheel.edn {:server-port 5000 :builds [{:id ...}]} (start-figwheel! ;; using the configuration shape of figwheel.edn {:server-port 5000 :builds (figwheel-sidecar.config/get-project-builds) :builds-to-start ["example"]}) (start-figwheel! ;; using the soon to be deprecated legacy configuration shape {:figwheel-options { :server-port 4000 } :all-builds [{:id ...}] :build-ids ["example"]}) As seen above you can also directly supply a configuration Map that has the shape of a figwheel.edn file or the legacy format which will be deprecated in the near future. (start-figwheel! (figwheel-sidecar.config/fetch-config) "example" "example-admin") After supplying a configuration, you can also list the build-ids that you would like to start.
(start-figwheel-system {:keys [figwheel-options all-builds build-ids]
:as options})
(start-repl start-fn figwheel-system)
(start-repl start-fn figwheel-system start-build-id)
(start-repl start-fn {:keys [system]} start-build-id repl-options)
(stop-autobuild system ids)
Stops autobuilding the specific ids or all currently running autobuilds
Stops autobuilding the specific ids or all currently running autobuilds
(switch-to-build system ids)
Switches autobuilding from the current autobuilds to the given build ids
Switches autobuilding from the current autobuilds to the given build ids
(system-remove system ids)
Remove the ids from the system
Remove the ids from the system
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close