Liking cljdoc? Tell your friends :D

still.config

Configuration management for Still snapshot testing.

Supports configuration from:

  • deps.edn / bb.edn / project.clj (:still/config key)
  • deps.edn aliases (:still/config in :aliases map)
  • Runtime overrides via still.config/override!
  • Environment variables (for CI/CD)

Alias-specific configuration in deps.edn is detected automatically from:

  • clojure.basis system property (when using tools.deps)
  • STILL_ALIASES environment variable (comma-separated)

All configuration keys accept both British and American spellings (e.g., :colour? or :color?, :serialisers or :serializers).

Configuration management for Still snapshot testing.

Supports configuration from:
- deps.edn / bb.edn / project.clj (:still/config key)
- deps.edn aliases (:still/config in :aliases map)
- Runtime overrides via still.config/override!
- Environment variables (for CI/CD)

Alias-specific configuration in deps.edn is detected automatically from:
- clojure.basis system property (when using tools.deps)
- STILL_ALIASES environment variable (comma-separated)

All configuration keys accept both British and American spellings
(e.g., :colour? or :color?, :serialisers or :serializers).
raw docstring

auto-update?clj/s

(auto-update?)

Check if automatic snapshot updates are enabled.

When true, mismatched snapshots are automatically updated instead of failing.

Check if automatic snapshot updates are enabled.

When true, mismatched snapshots are automatically updated instead of failing.
sourceraw docstring

color?clj/s

(color?)

Check if coloured output is enabled.

Check if coloured output is enabled.
sourceraw docstring

diff-context-linesclj/s

(diff-context-lines)

Get the number of context lines to show in diffs.

Get the number of context lines to show in diffs.
sourceraw docstring

get-configclj/s

(get-config)

Get the current configuration.

Configuration is cached for performance. Use invalidate-config-cache! to force a reload.

Get the current configuration.

Configuration is cached for performance. Use invalidate-config-cache! to force a reload.
sourceraw docstring

get-valueclj/s

(get-value k)

Get a specific configuration value by key.

Example: (config/get-value :snapshot-dir) => "test/still" (config/get-value :enabled?) => true

Get a specific configuration value by key.

Example:
  (config/get-value :snapshot-dir) => "test/still"
  (config/get-value :enabled?) => true
sourceraw docstring

invalidate-config-cache!clj/s

(invalidate-config-cache!)

Invalidate the configuration cache.

Forces the next call to get-config to reload configuration from all sources. Useful when configuration files change during development.

Invalidate the configuration cache.

Forces the next call to get-config to reload configuration from all sources.
Useful when configuration files change during development.
sourceraw docstring

merge-override!clj/s

(merge-override! config-map)

Merge additional configuration into runtime overrides. Invalidates the config cache.

Example: (config/merge-override! {:auto-update? true})

Merge additional configuration into runtime overrides.
Invalidates the config cache.

Example:
  (config/merge-override! {:auto-update? true})
sourceraw docstring

metadata?clj/s

(metadata?)

Check if snapshot metadata tracking is enabled.

Check if snapshot metadata tracking is enabled.
sourceraw docstring

override!clj/s

(override! config-map)

Override configuration at runtime.

This has the highest precedence and will override all file-based config. Invalidates the config cache.

Example: (config/override! {:snapshot-dir "test/snapshots" :auto-update? true})

To clear overrides: (config/override! {})

Override configuration at runtime.

This has the highest precedence and will override all file-based config.
Invalidates the config cache.

Example:
  (config/override! {:snapshot-dir "test/snapshots"
                     :auto-update? true})

To clear overrides:
  (config/override! {})
sourceraw docstring

serializersclj/s

(serializers)

Get the map of custom serialisers.

Get the map of custom serialisers.
sourceraw docstring

snapshot-dirclj/s

(snapshot-dir)

Get the configured snapshot directory path.

Get the configured snapshot directory path.
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