Raxol.Terminal.Config.Capabilities (Raxol v0.3.0)

View Source

Terminal capability detection and management.

Provides functionality to detect and determine terminal capabilities such as color support, unicode support, etc.

Summary

Functions

Merges detected capabilities with configuration using a specific adapter.

Detects terminal capabilities based on the environment using a specific adapter.

Creates an optimized configuration based on detected capabilities using the default adapter.

Creates an optimized configuration based on detected capabilities using a specific adapter.

Functions

apply_capabilities(config, adapter_module)

Merges detected capabilities with configuration using a specific adapter.

Takes a terminal configuration and enhances it with detected capabilities where those capabilities aren't already explicitly configured.

Parameters

  • config - The existing configuration
  • adapter_module - The module implementing EnvironmentAdapterBehaviour.

Returns

The configuration enhanced with detected capabilities.

detect_capabilities(adapter_module)

Detects terminal capabilities based on the environment using a specific adapter.

This examines environment variables, terminal responses, and other indicators to determine capabilities of the current terminal.

Parameters

  • adapter_module - The module implementing EnvironmentAdapterBehaviour.

Returns

A map of detected capabilities.

optimized_config()

Creates an optimized configuration based on detected capabilities using the default adapter.

This generates a configuration that's optimized for the current terminal environment, balancing features and performance.

Returns

An optimized configuration for the current terminal.

optimized_config(adapter_module)

Creates an optimized configuration based on detected capabilities using a specific adapter.

Parameters

  • adapter_module - The module implementing EnvironmentAdapterBehaviour.

Returns

An optimized configuration for the current terminal.