LiveStyle.Config.Validation (LiveStyle v0.12.0)

View Source

Configuration for CSS property validation.

Controls how LiveStyle validates property names and handles unknown, vendor-prefixed, and deprecated properties.

All configuration is compile-time only (like StyleX Babel plugin config). Changing these settings requires recompilation.

Summary

Functions

deprecated?()

Returns the deprecated? function for checking deprecated CSS properties.

deprecated_property_level()

Returns the level of deprecated property handling.

unknown_property_level()

Returns the level of unknown property handling.

validate_properties?()

Returns whether property validation is enabled.

vendor_prefix_level()

Returns the level of vendor prefix property handling.

Functions

deprecated?()

@spec deprecated?() :: (String.t() -> boolean() | nil) | {module(), atom()} | nil

Returns the deprecated? function for checking deprecated CSS properties.

Used during validation to check if properties are deprecated. Should be a function that takes a property name and returns a boolean (or nil if unknown).

Default is nil (no deprecation checking).

Configuration

config :live_style, deprecated?: &MyAppWeb.CSS.deprecated?/1

Function Signature

@spec deprecated?(String.t()) :: boolean() | nil

deprecated_property_level()

@spec deprecated_property_level() :: :warn | :ignore

Returns the level of deprecated property handling.

When a deprecated CSS property is used (e.g., clip), this setting controls the behavior. Requires the deprecated? config to be set.

  • :warn (default) - Log a warning about the deprecated property
  • :ignore - Silently allow deprecated properties

Example:

config :live_style, deprecated_property_level: :ignore

unknown_property_level()

@spec unknown_property_level() :: :warn | :error | :ignore

Returns the level of unknown property handling.

  • :warn (default) - Log a warning with suggestions
  • :error - Raise a CompileError
  • :ignore - Silently allow unknown properties

Example:

config :live_style, unknown_property_level: :error

validate_properties?()

@spec validate_properties?() :: boolean()

Returns whether property validation is enabled.

When enabled, LiveStyle validates CSS property names at compile time and warns or errors on unknown properties with "did you mean?" suggestions.

Custom properties (starting with --) are always allowed.

Default is true. Disable if you need to use non-standard properties:

config :live_style, validate_properties: false

vendor_prefix_level()

@spec vendor_prefix_level() :: :warn | :ignore

Returns the level of vendor prefix property handling.

When a vendor-prefixed property is used (e.g., -webkit-mask-image) and the configured prefix_css would add that prefix automatically for the standard property (e.g., mask-image), this setting controls the behavior.

  • :warn (default) - Log a warning suggesting to use the standard property
  • :ignore - Silently allow vendor-prefixed properties

Example:

config :live_style, vendor_prefix_level: :ignore