Pure functions for the guidance engine. Renders contextual help messages, startup dashboards, and tips. No I/O, no logging — all pure data transformations.
Pure functions for the guidance engine. Renders contextual help messages, startup dashboards, and tips. No I/O, no logging — all pure data transformations.
All REPL commands grouped by category.
All REPL commands grouped by category.
(format-commands)Format the command palette as a string.
Format the command palette as a string.
(format-post-scaffold-guidance module-name)Renders guidance shown after scaffolding a module.
module-name is the module name string.
Renders guidance shown after scaffolding a module. `module-name` is the module name string.
(format-startup-dashboard {:keys [components errors database web-url admin-url
nrepl-port modules guidance-level]
:or {components 0 errors 0 guidance-level :full}})Renders the startup dashboard box as a string.
system-info is a map with keys:
:components - number of running components
:errors - number of component errors
:database - database description string (e.g. "PostgreSQL @ localhost:5432/mydb")
:web-url - web URL (e.g. "http://localhost:3000")
:admin-url - admin URL or nil
:nrepl-port - nREPL port number
:modules - seq of active module name strings
:guidance-level - current guidance level keyword
Renders the startup dashboard box as a string. `system-info` is a map with keys: :components - number of running components :errors - number of component errors :database - database description string (e.g. "PostgreSQL @ localhost:5432/mydb") :web-url - web URL (e.g. "http://localhost:3000") :admin-url - admin URL or nil :nrepl-port - nREPL port number :modules - seq of active module name strings :guidance-level - current guidance level keyword
(format-tip tip guidance-level)Format a tip string for display.
Format a tip string for display.
Available guidance levels in order of verbosity.
Available guidance levels in order of verbosity.
(pick-tip context shown-tips)Pick a non-repeating tip for the given context.
context is a keyword from the tips map.
shown-tips is a set of previously shown tip strings.
Returns [tip-string updated-shown-tips] or nil if all tips shown.
Pick a non-repeating tip for the given context. `context` is a keyword from the tips map. `shown-tips` is a set of previously shown tip strings. Returns [tip-string updated-shown-tips] or nil if all tips shown.
Curated tips mapped to action contexts.
Curated tips mapped to action contexts.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |