jekyll-imgflow 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e314c5d37485b9d821e58bd4614798c9e61e3b944c60f6bbb948fb50a6fe9c2b
-  data.tar.gz: f9b64d4bc5119727cda256d7e1b1fb77e9ee6c9a1b19e97175290cf8f23df1c9
+  metadata.gz: c30d610c031609c2e1e9040c115d7162013db83ee6149d76bdb87bc97ad7137c
+  data.tar.gz: 8c9f212eb074af380df14d2f168f9d9379db196c8ec9b1a4111a850f804015e6
 SHA512:
-  metadata.gz: 9102a522a856e6fe440eb207b31c18d350e81a68055b13745ef835e51d257920e115b0054af3494534f9116e89616b13d99fd57c9aed132250bce6e98f280497
-  data.tar.gz: e6039b8fe325d7604fea5267c2f9fdfa40b8990647a8e0dfa936c7c2add4376b66cca4a28d8f548f6c0799321660f076902a27cba4dc3e734c424a683b7c0fdd
+  metadata.gz: a7f9640c4e7332e769481922c2569114baccc396b6ec4c354f21292421c489ce2d98a3ceaabe50043e10cb351ec497dd88069fb8efe3c3af162774d5148d0adc
+  data.tar.gz: a4d19058e5c05578d51a3cb96e6ccf84e84c0516b35cb26ec8c49e7ae18314bdc04725726976d49cdfe9e7e5507be2a18ecc311b66d956e55913ea60eb9f0235

data/README.md

@@ -4,7 +4,9 @@
 
 A [Jekyll](https://jekyllrb.com/) plugin for automatic image optimization with multiple providers and formats.
 
-[![DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/gundestrup/jekyll-imgflow)
+[![CI](https://github.com/gundestrup/jekyll-imgflow/actions/workflows/ci.yml/badge.svg)](https://github.com/gundestrup/jekyll-imgflow/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/jekyll-imgflow)](https://rubygems.org/gems/jekyll-imgflow)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/gundestrup/jekyll-imgflow)
 [![Status](https://img.shields.io/badge/status-active-success)](https://github.com/gundestrup/jekyll-imgflow)
 [![Semgrep](https://img.shields.io/badge/Semgrep-scanned-1B2B34?logo=semgrep&logoColor=white)](https://semgrep.dev/)
 [![CodeFactor](https://www.codefactor.io/repository/github/gundestrup/jekyll-imgflow/badge)](https://www.codefactor.io/repository/github/gundestrup/jekyll-imgflow)
@@ -35,7 +37,7 @@ imgflow:
 > **Configuration:** Only `originals` and `output` are required in `_config.yml`
 > — everything else has sensible defaults. See the
 > [Installation Guide](docs/installation.md#4-add-to-_configyml) for full options.
-
+>
 > **Note:** Image references require exact filenames (or paths relative to
 > `originals`). There is no fuzzy matching during the build yet — if you type
 > `photo.jpg` but the file is `photo.jpeg`, the build will fail with an error.
@@ -55,21 +57,26 @@ imgflow:
 ## 📚 Documentation
 
 ### Getting Started
+
 - **[Installation Guide](docs/installation.md)** - Detailed setup instructions
 - **[Basic Usage](docs/usage/)** - Core functionality and examples
+- **[Tag Options](docs/usage/tag-options.md)** - Every `{% imgflow %}` parameter
 - **[Picture Tag Migration](docs/picture_tag_migration.md)** - Migrate from Picture Tag
 
 ### Configuration
+
 - **[Provider Setup](docs/providers.md)** - Configure image providers
 - **[Docker Services](docs/docker.md)** - Using Docker containers
 - **[Presets System](docs/usage/presets.md)** - Predefined configurations
 
 ### Development
+
 - **[Development Guide](docs/development.md)** - Contributing and setup
 - **[Testing Guide](docs/testing.md)** - Running and writing tests
 - **[Scripts Reference](docs/scripts.md)** - Development utilities
 
 ### Performance
+
 - **[Provider Comparison](docs/providers.md)** - Performance benchmarks
 - **[Parallel Testing](docs/parallel_testing.md)** - Fast test execution
 
@@ -80,6 +87,7 @@ ImgFlow has two processing flows: **Build-Time** (pre-generation) and **Runtime*
 **See:** [ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed component architecture and data flow
 
 ### Quick Overview
+
 - **Build-Time Flow** - Pre-generate images during Jekyll build
 - **Runtime Flow** - Process images on-demand during template rendering
 - **Providers** - Image processing backends (CLI tools, HTTP APIs)
@@ -88,11 +96,13 @@ ImgFlow has two processing flows: **Build-Time** (pre-generation) and **Runtime*
 ## 🎯 Provider Support
 
 ### HTTP API Services (Recommended)
+
 - **[Imgproxy](https://github.com/imgproxy/imgproxy)** - Fast, reliable (Port 4022)
 - **[Weserv](https://github.com/weserv/images)** - Battle-tested (Port 4026)
 - **[Flyimg](https://github.com/flyimg/flyimg)** - On-the-fly processing (Port 4030)
 
 ### CLI Tools (Local)
+
 - **[Sharp](https://github.com/lovell/sharp)** - Node.js/libvips processing
 - **[ImageMagick](https://github.com/ImageMagick/ImageMagick)** - Feature-rich
 - **[LibVips](https://github.com/libvips/libvips)** - Memory efficient
@@ -143,6 +153,7 @@ rake check_services                  # Verify services
 ## 📦 Installation
 
 ### Quick Setup
+
 ```bash
 # Add to Gemfile
 gem 'jekyll-imgflow'
@@ -167,6 +178,8 @@ imgflow:
 
 **See:** [installation.md](docs/installation.md) for detailed installation and
 [all configuration options](docs/installation.md#4-add-to-_configyml),
+[tag-options.md](docs/usage/tag-options.md) for every `{% imgflow %}` option
+(operations, HTML attributes, `markup:` output formats),
 [presets.md](docs/usage/presets.md) for the preset system
 
 ## 🐳 Docker Setup (Recommended)
@@ -206,7 +219,7 @@ bin/imgflow_migrate_presets
 Latest benchmarks show **Sharp** as the fastest provider:
 
 | Provider | Time (s) | Speed |
-|----------|----------|-------|
+| ---------- | ---------- | ------- |
 | [Sharp](https://github.com/lovell/sharp) | 13.97 | 🏆 Fastest |
 | [LibVips](https://github.com/libvips/libvips) | 21.89 | Very Fast |
 | [Weserv](https://github.com/weserv/images) | 30.19 | Fast |
@@ -218,6 +231,7 @@ Latest benchmarks show **Sharp** as the fastest provider:
 ## 🛠️ Development
 
 ### Quick Setup
+
 ```bash
 # Clone and setup
 git clone <repository>
@@ -231,7 +245,7 @@ rake download_test_images
 rake ci
 
 # Run the local Semgrep Pro rules directly
-semgrep scan --pro --config .semgrep.yml --error lib/
+semgrep scan --pro --config .semgrep.yml --error .
 
 # Sync the repository scan and findings with the Semgrep dashboard
 # (requires semgrep login or SEMGREP_APP_TOKEN)
@@ -239,6 +253,7 @@ semgrep ci
 ```
 
 ### Key Files
+
 - **`lib/jekyll-imgflow.rb`** - Main module
 - **`lib/jekyll-imgflow/imgflow_tag.rb`** - Main tag implementation
 - **`lib/jekyll-imgflow/html_generator.rb`** - HTML generation

data/interface.yml

@@ -0,0 +1,63 @@
+# Generated by `rake interface` — do not edit.
+# Public tag/config surface for tooling (editor extensions, doc linters).
+---
+gem: jekyll-imgflow
+version: 0.4.2
+tags:
+  imgflow:
+    params:
+    - alt
+    - aspect_ratio
+    - class
+    - format
+    - formats
+    - height
+    - keep
+    - level
+    - link
+    - loading
+    - markup
+    - modal
+    - opacity
+    - optimize
+    - position
+    - preset
+    - quality
+    - ratio
+    - title
+    - watermark
+    - width
+filters: []
+config:
+  imgflow:
+  - backend_priority
+  - cache_dir
+  - fallback_format
+  - flyimg_url
+  - formats
+  - image_modal
+  - imgproxy_url
+  - input_formats
+  - optimize_qualities
+  - originals
+  - output
+  - quality
+  - sharp_url
+  - sizes
+  - weserv_url
+enums:
+  markup:
+  - auto
+  - data_auto
+  - data_img
+  - data_picture
+  - direct_url
+  - img
+  - naked_srcset
+  - picture
+  level:
+  - default
+  - high
+  - low
+  - maximum
+  - medium

data/lib/jekyll-imgflow/hooks.rb

@@ -33,7 +33,7 @@ module JekyllImgFlow
   end
 
   # Save final manifest after template rendering (single writer)
-  Jekyll::Hooks.register :site, :post_write do |site|
+  Jekyll::Hooks.register :site, :post_write, priority: :normal do |site|
     Jekyll.logger.info "🔌 ImgFlow post_write hook - saving final manifest with page usage"
 
     if site.imgflow_components && site.imgflow_components[:manifest]

data/lib/jekyll-imgflow/html_generator.rb

@@ -6,6 +6,11 @@ module JekyllImgFlow
   class HtmlGenerator
     include ModalWrapper
 
+    # Markup formats accepted via `markup:` (see docs/usage/tag-options.md).
+    # Unknown values fall back to `img`.
+    MARKUP_FORMATS = %w[img picture auto data_img data_picture data_auto
+                        direct_url naked_srcset].freeze
+
     # Generate HTML based on markup format and attributes
     # @param results [Array<String>] Processed image paths
     # @param attributes [Hash] HTML attributes by element

data/lib/jekyll-imgflow/imgflow_tag.rb

@@ -113,7 +113,8 @@ module Jekyll
       relative_modal_results = modal_results.uniq.map do |result|
         relative_result_path(result, site)
       end
-      parsed = parsed.merge(markup_format: "picture") if relative_results.length > 1
+      auto_markup = [nil, "auto"].include?(parsed[:markup_format])
+      parsed = parsed.merge(markup_format: "picture") if relative_results.length > 1 && auto_markup
       generate_html(relative_results, parsed.merge(modal_results: relative_modal_results), context)
     end
 

data/lib/jekyll-imgflow/interface.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module JekyllImgFlow
+  # Machine-readable description of the plugin's public interface:
+  # Liquid tags + their params, config keys, and enum values.
+  # `rake interface` writes this as interface.yml (shipped in the gem) so
+  # tooling like editor extensions can consume it without parsing Ruby.
+  module Interface
+    TAGS = {
+      "imgflow" => (Parser::OPERATION_PARAMS + Parser::HTML_ATTRIBUTES + %i[markup])
+                   .map(&:to_s).sort.freeze
+    }.freeze
+
+    # Config keys read outside CORE_CONFIG_DEFAULTS in config.rb
+    EXTRA_CONFIG_KEYS = %w[
+      cache_dir image_modal imgproxy_url weserv_url flyimg_url sharp_url
+      optimize_qualities
+    ].freeze
+
+    def self.to_h
+      {
+        "gem" => "jekyll-imgflow",
+        "version" => VERSION,
+        "tags" => TAGS.transform_values { |params| { "params" => params } },
+        "filters" => [],
+        "config" => {
+          "imgflow" => (Config::CORE_CONFIG_DEFAULTS.keys + EXTRA_CONFIG_KEYS).sort
+        },
+        "enums" => {
+          "markup" => HtmlGenerator::MARKUP_FORMATS.sort,
+          "level" => %w[default high low maximum medium]
+        }
+      }
+    end
+  end
+end

data/lib/jekyll-imgflow/parser.rb

@@ -185,6 +185,7 @@ module JekyllImgFlow
         operations: [],
         html_attributes: {},
         raw_options: raw_options,
+        markup_format: nil,
         preset: nil,
         error: error_message
       }
@@ -196,6 +197,7 @@ module JekyllImgFlow
         operations: operations,
         html_attributes: html_attributes,
         raw_options: raw_options,
+        markup_format: raw_options[:markup] || raw_options[:markup_format],
         preset: raw_options[:preset]
       }
     end

data/lib/jekyll-imgflow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllImgFlow
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/jekyll-imgflow.rb

@@ -29,6 +29,7 @@ require_relative "jekyll-imgflow/imgflow_tag"
 require_relative "jekyll-imgflow/picture_tag_adaptor"
 require_relative "jekyll-imgflow/picture_tag_preset_migrator"
 require_relative "jekyll-imgflow/hooks"
+require_relative "jekyll-imgflow/interface"
 
 module JekyllImgFlow
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-imgflow
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Svend Gundestrup
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- interface.yml
 - lib/jekyll-imgflow.rb
 - lib/jekyll-imgflow/animated_gif_detector.rb
 - lib/jekyll-imgflow/batch_manager.rb
@@ -73,6 +74,7 @@ files:
 - lib/jekyll-imgflow/hooks.rb
 - lib/jekyll-imgflow/html_generator.rb
 - lib/jekyll-imgflow/imgflow_tag.rb
+- lib/jekyll-imgflow/interface.rb
 - lib/jekyll-imgflow/manifest_manager.rb
 - lib/jekyll-imgflow/modal_assets.rb
 - lib/jekyll-imgflow/operation_processor.rb