sebnitu / vrembem / 9786902854

92%

main: 100%

push

github

Add new usage module and configuration to only output CSS vars when used. (#1913)

This PR introduces two new modules to `@vrembem/core` that helps to manage usage information and output of CSS custom properties as well as library wide configurations. The `css`, `palette` and `theme` modules have also been refactored to integrate `config` and `usage`. These new modules and their API include:

- `@vrembem/core/config`
  - `@function get()` - Returns the value of an option in the configuration map.
  - `@mixin set()` - Set an option in the configuration map.
  - `@mixin remove()` - Remove an option from the configuration map.
  - `@mixin log()` - Log to console the entire options configuration map.
- `@vrembem/core/usage`
  - `@function get()` - Return a value from the usage `$_meta` map.
  - `@function set()` - Set the meta data for a module's property based on the action being taken.
  - `@function remove()` - Remove a property from the usage `$_meta` map.
  - `@mixin output()` - Output custom properties based on the provided strategy. This can either be all (via "*" or "all" values) or "used" meaning only the custom properties that have been referenced get output.
  - `@mixin log()` - Log to console data from the `$_meta` custom properties map. The log can be filtered using a module name and further with a specific data map to match.

**Additional changes**
- `css` requires passing a module for most API calls.
- `palette` seeds map has been made private and `$lightness` has been renamed to `$lightness-range`. The `build()` mixin has also been refactored to be used as a function with the built map as a return. A new `update()` mixin has been added to replace the uses of the previous build mixin.
- `theme` module now take modules param first and the themes map has been refactored to be organized within modules groups similar to the `css` module custom properties map.
- Added `log()` mixins for all modules and optional module filtering... (continued)

500 of 500 branches covered (100.0%)

Branch coverage included in aggregate %.

2293 of 2293 relevant lines covered (100.0%)

34.21 hits per line