figwheel-sidecar.repl-api — figwheel-sidecar 0.5.17

*repl-api-system* clj

api-help clj

(api-help)

Print out help for the Figwheel REPL api

app-trans clj

(app-trans func)

(app-trans func ids)

build-once clj

(build-once & ids)

Compiles the builds with the provided build ids (or the current default ids) once.

build-once-from-lein clj

(build-once-from-lein narrowed-project build-ids)

call-hook-fn clj

(call-hook-fn ky hook-fn)

clean-builds clj

(clean-builds & ids)

Deletes the compiled artifacts for the builds with the provided build ids (or the current default ids).

cljs-repl clj

(cljs-repl)

(cljs-repl id)

Starts a Figwheel ClojureScript REPL for the provided build id (or the first default id).

dispatch-config-source clj

(dispatch-config-source project-config-source)

fig-status clj

(fig-status)

Display the current status of the running Figwheel system.

figwheel-running? clj

(figwheel-running?)

launch-from-lein clj

(launch-from-lein narrowed-project build-ids)

launch-init clj

(launch-init figwheel-internal-final)

print-config clj

(print-config & ids)

Prints out the build configs currently focused or optionally the configs of the ids provided.

reload-config clj

(reload-config)

Reloads the build config, and resets the autobuild.

remove-system clj

(remove-system)

repl-env clj

(repl-env)

(repl-env id)

Returns repl-env for use in editors with Piggieback support.

reset-autobuild clj

(reset-autobuild)

Stops the currently running autobuilder, cleans the current builds, and starts building the default builds again.

resolve-hook-fn clj

(resolve-hook-fn ky hook)

start-autobuild clj

(start-autobuild & ids)

Starts a Figwheel autobuild process for the builds associated with the provided ids (or the current default ids).

start-figwheel! clj

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-from-lein clj

(start-figwheel-from-lein figwheel-internal-config-data)

stop-autobuild clj

(stop-autobuild & ids)

Stops the currently running autobuild process.

stop-figwheel! clj

(stop-figwheel!)

If a figwheel process is running, this will stop all the Figwheel autobuilders and stop the figwheel Websocket/HTTP server.

switch-to-build clj

(switch-to-build & ids)

Stops the currently running autobuilder and starts building the builds with the provided ids.

system-asserts clj

(system-asserts)

validate-and-return-final-config-data clj

(validate-and-return-final-config-data narrowed-project build-ids)

validate-figwheel-conf clj

(validate-figwheel-conf project-config-source options)

wrap-destroy clj

(wrap-destroy destroy-hook thunk)