DSL (dsl v0.1.0)

Copy Markdown View Source

Composable building blocks for Elixir-native DSLs.

Summary

Functions

__using__(opts)

Import DSL macros and install compile-time scope metadata.

active?(key)

Return true when the keyed scope is active.

attach(owner, child_name, child)

Attach a child value to the nearest active accepting scope.

current(key)

Return the active scope state, or nil when inactive.

current!(key)

Return the active scope state.

current_scope!(key)

Return the active scope struct.

current_scope_state!(key, name)

Return active scope state with a readable scope-name error.

finish(key, expected_name \\ nil)

Finish the active DSL scope.

finish_scope(key, name)

Finish the active scope with a readable scope-name error.

get_setting(key, default \\ nil)

Return a process-local DSL setting or its default value.

options(name, opts \\ [], list)

Declare a named Ecto-style option schema.

put_setting(key, value)

Store a process-local DSL setting.

require_scope!(owner, required, opts \\ [])

Require an active scope by name for the calling DSL owner.

require_scopes!(owner, scope, required)

Require all active scopes by name for the calling DSL owner.

reset(key)

Reset a scope stack.

reset_setting(key)

Reset a process-local DSL setting.

scope(name, opts \\ [], block \\ [])

Declare a named process-local DSL scope.

setting(name, opts \\ [])

Declare a named process-local DSL setting.

start(key, name, state, location \\ nil)

Start a named DSL scope.

update(key, fun)

Update the active scope state.

update_scope(key, name, fun)

Update the active scope state with a readable directive error.

Functions

__using__(opts)

(macro)

Import DSL macros and install compile-time scope metadata.

active?(key)

Return true when the keyed scope is active.

attach(owner, child_name, child)

Attach a child value to the nearest active accepting scope.

current(key)

Return the active scope state, or nil when inactive.

current!(key)

Return the active scope state.

current_scope!(key)

Return the active scope struct.

current_scope_state!(key, name)

Return active scope state with a readable scope-name error.

finish(key, expected_name \\ nil)

Finish the active DSL scope.

finish_scope(key, name)

Finish the active scope with a readable scope-name error.

get_setting(key, default \\ nil)

Return a process-local DSL setting or its default value.

options(name, opts \\ [], list)

(macro)

Declare a named Ecto-style option schema.

put_setting(key, value)

Store a process-local DSL setting.

require_scope!(owner, required, opts \\ [])

Require an active scope by name for the calling DSL owner.

require_scopes!(owner, scope, required)

Require all active scopes by name for the calling DSL owner.

reset(key)

Reset a scope stack.

reset_setting(key)

Reset a process-local DSL setting.

scope(name, opts \\ [], block \\ [])

(macro)

Declare a named process-local DSL scope.

setting(name, opts \\ [])

(macro)

Declare a named process-local DSL setting.

start(key, name, state, location \\ nil)

Start a named DSL scope.

update(key, fun)

Update the active scope state.

update_scope(key, name, fun)

Update the active scope state with a readable directive error.