Liking cljdoc? Tell your friends :D

boundary.devtools.core.error-formatter

Rich error output formatting for development mode. Pure functions — catalog data loaded once at namespace init via boundary.devtools.error-codes.

Rich error output formatting for development mode.
Pure functions — catalog data loaded once at namespace init via boundary.devtools.error-codes.
raw docstring

format-config-errorclj

(format-config-error {:keys [code config-key expected found reason fix]})

Format a configuration error with specific fix instructions. error-info is a map with: :code - BND-1xx error code :config-key - the config key path (e.g. :boundary/user-service :jwt-secret) :expected - what was expected (e.g. "#env JWT_SECRET") :found - what was found (e.g. nil) :reason - why this is needed :fix - specific fix instructions

Format a configuration error with specific fix instructions.
`error-info` is a map with:
  :code      - BND-1xx error code
  :config-key - the config key path (e.g. :boundary/user-service :jwt-secret)
  :expected   - what was expected (e.g. "#env JWT_SECRET")
  :found      - what was found (e.g. nil)
  :reason     - why this is needed
  :fix        - specific fix instructions
sourceraw docstring

format-enriched-errorclj

(format-enriched-error enriched)
(format-enriched-error {:keys [code stacktrace suggestions fix dashboard-url
                               docs-url]}
                       {:keys [guidance-level] :or {guidance-level :full}})

Format a fully enriched error map for rich development output. Combines the BND code header, stack trace, and auto-fix suggestion.

opts (optional): :guidance-level — :full (default), :minimal, or :off At :off, auto-fix hints and dashboard/docs links are suppressed.

Format a fully enriched error map for rich development output.
Combines the BND code header, stack trace, and auto-fix suggestion.

opts (optional):
  :guidance-level — :full (default), :minimal, or :off
  At :off, auto-fix hints and dashboard/docs links are suppressed.
sourceraw docstring

format-errorclj

(format-error {:keys [code handler schema errors input example fix dashboard
                      docs]})

Format a rich error message for development output. error-info is a map with: :code - BND-xxx error code string :handler - handler keyword (optional) :schema - schema name (optional) :errors - seq of {:field :message :suggestion} maps (optional) :input - the input data that caused the error (optional) :example - example valid input (optional) :fix - fix suggestion string (optional) :dashboard - dashboard URL (optional) :docs - documentation URL (optional)

Format a rich error message for development output.
`error-info` is a map with:
  :code       - BND-xxx error code string
  :handler    - handler keyword (optional)
  :schema     - schema name (optional)
  :errors     - seq of {:field :message :suggestion} maps (optional)
  :input      - the input data that caused the error (optional)
  :example    - example valid input (optional)
  :fix        - fix suggestion string (optional)
  :dashboard  - dashboard URL (optional)
  :docs       - documentation URL (optional)
sourceraw docstring

format-fcis-violationclj

(format-fcis-violation {:keys [source-ns requires-ns module]})

Format an FC/IS boundary violation with refactoring guidance. violation is a map with: :source-ns - the core namespace that has the violation :requires-ns - the shell namespace it incorrectly requires :module - the module name

Format an FC/IS boundary violation with refactoring guidance.
`violation` is a map with:
  :source-ns   - the core namespace that has the violation
  :requires-ns - the shell namespace it incorrectly requires
  :module      - the module name
sourceraw docstring

format-unclassified-errorclj

(format-unclassified-error exception)

Format an unclassified error with a fallback message and AI hint.

Format an unclassified error with a fallback message and AI hint.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close