API Reference spark v2.2.55
View SourceModules
Tools to generate cheat sheets for spark DSLs
Helpers for meta programming around code and code snippets
Tools for generating docs & search data for extras.
The primary entry point for defining a DSL.
Utilities for building DSL objects programatically, generally used in transformers.
Declares a DSL entity.
An extension to the Spark DSL.
Allows splitting up a DSL into multiple modules, potentially organizing large DSLs
Supply this when defining an extension to add entity builders to another extension's section.
Declares a DSL section.
A transformer manipulates and/or validates the entire DSL state of a resource.
A verifier gets the dsl state and can return :ok or :error.
Verifies that each entity that has an identifier is unique at each path.
Used when a DSL is incorrectly configured.
Formats Spark modules.
Helpers for patching Spark DSLs.
Used to dynamically generate configuration functions for Spark extensions based on their DSL.
Provides a standard API to handle keyword-list-based options.
Helpers for use with spark options
An error that is returned (or raised) when options are invalid.
Defines a validator module for an option schema.
Helpers for working with options lists.
Mix Tasks
Creates cheat sheets for each Extension provided. Useful for CI with --check flag.
Includes generated cheat sheets in the search bar
Manages a variable called spark_locals_without_parens in the .formatter.exs from a list of DSL extensions.
Installs spark by adding the Spark.Formatter plugin, and providing a basic configuration for it in config.exs.
Replaces any documentation links with text appropriate for hex docs.