markawesome 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561615ddddb39ccde6417037237c2bc490d2ded75aba4b36faf77e1db0eac1cc
-  data.tar.gz: 10ce10fcf7a740754303363579558de85881b4a9e101c73525c7d6ce3ca674e4
+  metadata.gz: dde7893cda313985c975f86e5521db8a3f56268ebf8d0df5b304719e8db5b73b
+  data.tar.gz: 73e885ac60dfbe2b8734d44aa135fb345440c977390d8d3d7a22cc577328eadf
 SHA512:
-  metadata.gz: 48b713e5d9b0cd1f182ce321923d02c59c85132c42b75ef2f58088dc5ed433101dac9049ea76abd5858f8f03779c7f56a25a7e2a2e21d484839f19bd8fd038f1
-  data.tar.gz: 034dda0ddfc5ca7c24d0107e10632dae1312d122170f65608a3b0bc224b3fe34289b829d68c306da39af08b0e62f16e963d92ad9c92d125ca91bebac06e321e9
+  metadata.gz: 1e4cab6567c4ef43c87472be12ec93d506fc7b4d47a9a7588aa4c99e28d58761e6705bbf56b0ed5efac032dff0960fa6af9d661042950aba516f76d8ee4881ac
+  data.tar.gz: 49df9a0d39e97272b3acd05b52980b86ace61eb00dd6be7e92d91dc90ec0c688b550e5b21e7999303c8f3dc6dd8188cac8d791c1fe5ad07baaac0ce10b23fd5c

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.0] - 2026-06-20
+
+### Added
+
+- The standalone `:::wa-icon` block now accepts `family` (`classic`, `sharp`, `duotone`, `sharp-duotone`, `brands`), `variant` (`thin`, `light`, `regular`, `solid`), and `animation` (`beat`, `fade`, `beat-fade`, `bounce`, `flip`, `shake`, `spin`, `spin-pulse`, `spin-reverse`) as bare enumerated tokens after the icon name (order-independent, rightmost-wins, unknown tokens dropped — same parsing as button `variant`/`size`). The block body becomes the icon's accessible `label` (stripped, whitespace-collapsed, HTML-escaped); an empty body emits no `label`, leaving the icon presentational per Web Awesome's default. Emit order is deterministic: `name family variant animation label`.
+- `CalloutTransformer` callouts can now override their icon's `family`/`variant`/`animation` using the same bare tokens on the callout line (e.g. `:::warning shake`). The historical `variant="solid"` default is preserved when no icon-variant token is given, so existing callouts render byte-identically. Works alongside the existing `icon:name` override.
+- New shared `Markawesome::IconAttributes` module — single source of truth for the `<wa-icon>` family/variant/animation vocabulary (verified against Web Awesome 3.x), consumed by both `IconTransformer` and `CalloutTransformer`.
+
+The inline `$$$name` form stays **name-only** (mid-prose, semantically decorative). Embedded `icon:slot:name` icons in button/tag/details are unchanged. Note: `family`/`variant` produce a *visible* weight/family change only with a Font Awesome Pro kit; the attributes are always emitted to the DOM regardless of kit tier (validated against the examples site's WA 3.8.0 kit, where `animation` and `label` are fully functional and the weight/family attributes reach the element without a visible glyph swap on the free tier).
+
 ## [0.12.0] - 2026-06-19
 
 ### Added

data/lib/markawesome/icon_attributes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Markawesome
+  # Shared <wa-icon> attribute vocabulary (family/variant/animation) and emission helper.
+  # Values verified against Web Awesome 3.x. Adding a value later is a one-line change.
+  module IconAttributes
+    SCHEMA = {
+      family: %w[classic sharp duotone sharp-duotone brands],
+      variant: %w[thin light regular solid],
+      animation: %w[beat fade beat-fade bounce flip shake spin spin-pulse spin-reverse]
+    }.freeze
+
+    # Returns ordered ['family="…"', 'variant="…"', 'animation="…"'] for present keys.
+    def self.pairs(attributes)
+      %i[family variant animation].filter_map do |key|
+        "#{key}=\"#{attributes[key]}\"" if attributes[key]
+      end
+    end
+  end
+end

data/lib/markawesome/transformers/callout_transformer.rb

@@ -3,6 +3,7 @@
 require_relative 'base_transformer'
 require_relative '../attribute_parser'
 require_relative '../icon_slot_parser'
+require_relative '../icon_attributes'
 
 module Markawesome
   # Transforms callout syntax into wa-callout elements
@@ -28,20 +29,20 @@ module Markawesome
       transform_proc = proc do |variant, extra_params, inner_content|
         actual_variant = VARIANT_ALIASES.fetch(variant, variant)
 
-        # Parse icon tokens first, then pass remaining to AttributeParser
+        # Parse icon tokens first, then pass remaining to AttributeParser.
+        # CALLOUT_ATTRIBUTES and IconAttributes::SCHEMA namespaces are disjoint, so the
+        # same remaining-token string can be parsed against both independently.
         icon_result = IconSlotParser.parse(extra_params, ICON_SLOTS)
         extra_attrs = AttributeParser.parse(icon_result[:remaining], CALLOUT_ATTRIBUTES)
+        icon_attrs  = AttributeParser.parse(icon_result[:remaining], IconAttributes::SCHEMA)
+        icon_attrs[:variant] ||= 'solid' # preserve historical default
 
         attr_parts = ["variant=\"#{actual_variant}\""]
         attr_parts << "appearance=\"#{extra_attrs[:appearance]}\"" if extra_attrs[:appearance]
         attr_parts << "size=\"#{extra_attrs[:size]}\"" if extra_attrs[:size]
 
-        # Use custom icon if provided, otherwise use default variant icon
-        icon_html = if icon_result[:icons]['icon']
-                      "<wa-icon slot=\"icon\" name=\"#{icon_result[:icons]['icon']}\" variant=\"solid\"></wa-icon>"
-                    else
-                      icon_for(actual_variant)
-                    end
+        icon_name = icon_result[:icons]['icon'] || icon_name_for(actual_variant)
+        icon_html = callout_icon_html(icon_name, icon_attrs)
         html_content = "#{icon_html}#{markdown_to_html(inner_content)}"
 
         "<wa-callout #{attr_parts.join(' ')}>#{html_content}</wa-callout>"
@@ -79,11 +80,16 @@ module Markawesome
     class << self
       private
 
-      def icon_for(variant)
+      def icon_name_for(variant)
         config = Markawesome.configuration
         icons = config&.callout_icons || default_icons
-        icon_name = icons[variant.to_sym]
-        "<wa-icon slot=\"icon\" name=\"#{icon_name}\" variant=\"solid\"></wa-icon>"
+        icons[variant.to_sym]
+      end
+
+      def callout_icon_html(name, attributes)
+        parts = ['slot="icon"', "name=\"#{name}\""]
+        parts.concat(IconAttributes.pairs(attributes))
+        "<wa-icon #{parts.join(' ')}></wa-icon>"
       end
 
       def default_icons

data/lib/markawesome/transformers/icon_transformer.rb

@@ -1,17 +1,25 @@
 # frozen_string_literal: true
 
 require_relative 'base_transformer'
+require_relative '../attribute_parser'
+require_relative '../icon_attributes'
 
 module Markawesome
   # Transforms icon syntax into wa-icon elements
-  # Primary syntax: $$$icon-name
-  # Alternative syntax: :::wa-icon icon-name
+  # Primary syntax: $$$icon-name (name only, decorative)
+  # Alternative syntax: :::wa-icon icon-name [family] [variant] [animation]\n[label]\n:::
   #
   # Examples:
   # $$$settings -> <wa-icon name="settings"></wa-icon>
   # $$$home -> <wa-icon name="home"></wa-icon>
   # $$$user-circle -> <wa-icon name="user-circle"></wa-icon>
+  # :::wa-icon star spin\n::: -> <wa-icon name="star" animation="spin"></wa-icon>
+  # :::wa-icon heart solid\nFavorite\n::: ->
+  #   <wa-icon name="heart" variant="solid" label="Favorite"></wa-icon>
   class IconTransformer < BaseTransformer
+    # First-line params + optional multi-line body. The closer is anchored to a line
+    # start; the opener is intentionally not anchored so it still matches mid-prose.
+    ALTERNATIVE_REGEX = /:::wa-icon[ \t]+([^\n]*?)[ \t]*\n(.*?)^:::/m
     def self.transform(content)
       # Protect code blocks first
       protected_content, code_blocks = protect_code_blocks(content)
@@ -25,9 +33,16 @@ module Markawesome
       end
 
       # Apply alternative syntax transformation
-      result = result.gsub(/:::wa-icon\s+([a-zA-Z0-9\-_]+)\s*\n:::/m) do
-        icon_name = ::Regexp.last_match(1)
-        build_icon_html(icon_name)
+      result = result.gsub(ALTERNATIVE_REGEX) do
+        first_line = ::Regexp.last_match(1)
+        raw_body   = ::Regexp.last_match(2)
+
+        tokens     = first_line.strip.split(/\s+/)
+        icon_name  = tokens.shift # first token is always the name
+        attributes = AttributeParser.parse(tokens.join(' '), IconAttributes::SCHEMA)
+        label      = normalize_label(raw_body)
+
+        build_icon_html(icon_name, attributes, label)
       end
 
       # Restore code blocks
@@ -39,7 +54,12 @@ module Markawesome
 
       # Drop primary-syntax icons entirely.
       result = protected_content.gsub(/\$\$\$([a-zA-Z0-9\-_]+)(?![a-zA-Z0-9\-_]|\s+name\b)/, '')
-      result = result.gsub(/:::wa-icon\s+([a-zA-Z0-9\-_]+)\s*\n:::/m, '')
+
+      # A labeled block degrades to its label text (collapsed, not HTML-escaped — it
+      # re-enters a markdown stream); an unlabeled block degrades to ''.
+      result = result.gsub(ALTERNATIVE_REGEX) do
+        ::Regexp.last_match(2).to_s.strip.gsub(/\s+/, ' ')
+      end
 
       restore_code_blocks(result, code_blocks)
     end
@@ -47,12 +67,24 @@ module Markawesome
     class << self
       private
 
-      def build_icon_html(icon_name)
-        # Clean and validate icon name
-        clean_name = icon_name.strip
+      def build_icon_html(icon_name, attributes = {}, label = nil)
+        parts = ["name=\"#{icon_name.strip}\""]
+        parts.concat(IconAttributes.pairs(attributes))
+        parts << "label=\"#{label}\"" if label && !label.empty?
+        "<wa-icon #{parts.join(' ')}></wa-icon>"
+      end
+
+      # Label is an attribute VALUE, not markup: strip, collapse whitespace, HTML-escape.
+      # Deliberately NOT run through markdown_to_html (unlike button/callout bodies).
+      def normalize_label(raw_body)
+        text = raw_body.to_s.strip.gsub(/\s+/, ' ')
+        text.empty? ? nil : escape_html(text)
+      end
 
-        # Return the wa-icon element
-        "<wa-icon name=\"#{clean_name}\"></wa-icon>"
+      # Same escape set as Dialog/Popover transformers.
+      def escape_html(text)
+        text.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+            .gsub('"', '&quot;').gsub("'", '&#39;')
       end
 
       def protect_code_blocks(content)

data/lib/markawesome/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markawesome
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markawesome
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Janne Waren
@@ -79,6 +79,7 @@ files:
 - lib/markawesome.rb
 - lib/markawesome/attribute_parser.rb
 - lib/markawesome/code_block_protector.rb
+- lib/markawesome/icon_attributes.rb
 - lib/markawesome/icon_slot_parser.rb
 - lib/markawesome/plain_markdown_renderer.rb
 - lib/markawesome/transformer.rb